\n Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. \n After the instance(s) is attached, it becomes a part of the Auto Scaling group.\n
\nFor more information, see Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n " + "documentation": "\n\n Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. \n After the instance(s) is attached, it becomes a part of the Auto Scaling group.\n
\nFor more information, see Attach Amazon EC2 Instances to Your Existing Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n " + }, + "CompleteLifecycleAction": { + "name": "CompleteLifecycleAction", + "input": { + "shape_name": "CompleteLifecycleActionType", + "type": "structure", + "members": { + "LifecycleHookName": { + "shape_name": "AsciiStringMaxLen255", + "type": "string", + "pattern": "[A-Za-z0-9\\-_\\/]+", + "min_length": 1, + "max_length": 255, + "documentation": "\n\t\tThe name of the lifecycle hook.
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\tThe name of the Auto Scaling group to which the lifecycle hook belongs.
\n ", + "required": true + }, + "LifecycleActionToken": { + "shape_name": "LifecycleActionToken", + "type": "string", + "min_length": 36, + "max_length": 36, + "documentation": "\n\t\tA universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the \n\t\tlifecycle hook.
\n ", + "required": true + }, + "LifecycleActionResult": { + "shape_name": "LifecycleActionResult", + "type": "string", + "documentation": "\n\t\tThe action the Auto Scaling group should take. The value for this parameter can \n\t\tbe either CONTINUE or ABANDON.
The output of the CompleteLifecycleAction.
\n " + }, + "errors": [], + "documentation": "\n\t\tCompletes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.
\n\t\t\t\t\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t
\n\t\tTo learn more, see Auto Scaling Pending State and \n\t\tAuto Scaling Terminating State.
\n\t" }, "CreateAutoScalingGroup": { "name": "CreateAutoScalingGroup", @@ -121,7 +171,7 @@ "max_length": 255, "documentation": null }, - "documentation": "\nA list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.
\nFor information on using load balancers, see Use Load Balancer to Load Balance Your Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n \n " + "documentation": "\nA list of existing Elastic Load Balancing load balancers to use. The load balancers must be associated with the AWS account.
\nFor information on using load balancers, see Load Balance Your Auto Scaling Group\n in the Auto Scaling Developer Guide.
\n \n " }, "HealthCheckType": { "shape_name": "XmlStringMaxLen32", @@ -134,7 +184,7 @@ "HealthCheckGracePeriod": { "shape_name": "HealthCheckGracePeriod", "type": "integer", - "documentation": "\nLength of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health. During this time any health check failure for the that instance is ignored.
\nThis is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, \n before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to \n match the expected startup period of your application.
Length of time in seconds after a new Amazon EC2\n instance comes into service that Auto Scaling\n starts checking its health. During this time any health check failure for the that instance is ignored.
\nThis is required if you are adding ELB health check. Frequently, new instances need to warm up, briefly, \n before they can pass a health check. To provide ample warm-up time, set the health check grace period of the group to \n match the expected startup period of your application.
For more information, see Add an Elastic Load Balancing Health Check.
\n " }, "PlacementGroup": { "shape_name": "XmlStringMaxLen255", @@ -150,7 +200,7 @@ "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 1, "max_length": 255, - "documentation": "\nA comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
\nIf you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n
\nFor information on launching your Auto Scaling group into Amazon VPC subnets, see Launch Auto Scaling Instances into Amazon VPC\n in the Auto Scaling Developer Guide\n .
\n " + "documentation": "\nA comma-separated list of subnet identifiers of Amazon Virtual Private Clouds (Amazon VPCs).
\nIf you specify subnets and Availability Zones with this call, ensure that the subnets' Availability Zones \n match the Availability Zones specified.\n
\nFor information on launching your Auto Scaling group into Amazon VPC subnets, see Auto Scaling in Amazon Virtual Private Cloud\n in the Auto Scaling Developer Guide\n .
\n " }, "TerminationPolicies": { "shape_name": "TerminationPolicies", @@ -440,7 +490,7 @@ "AssociatePublicIpAddress": { "shape_name": "AssociatePublicIpAddress", "type": "boolean", - "documentation": "\nUsed for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). Specifies whether to assign a public IP address to each instance launched in a Amazon VPC.
\nIf you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
\nDefault: If the instance is launched into a default subnet in a default VPC, the default is true. \n If the instance is launched into a nondefault subnet in a VPC, the default is false. \n For information about the platforms supported by Auto Scaling, see \n Get Started with Auto Scaling Using the Command Line Interface.
Used for Auto Scaling groups that launch instances into an Amazon Virtual Private Cloud (Amazon VPC). \n Specifies whether to assign a public IP address to each instance launched in a Amazon VPC. For more information, see \n Auto Scaling in Amazon Virtual Private Cloud.
\nIf you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
\nDefault: If the instance is launched into a default subnet in a default VPC, the default is true. \n If the instance is launched into a nondefault subnet in a VPC, the default is false. \n For information about default VPC and VPC platforms, see \n Supported Platforms.
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched into a VPC.
For more information, see Auto Scaling in Amazon Virtual Private Cloud in the Auto Scaling Developer Guide.
\nValid values: default | dedicated
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware and can only be launched in a VPC.
You must set the value of this parameter to dedicated if want to launch Dedicated Instances in a shared tenancy VPC (VPC with instance placement tenancy attribute set to default).
If you specify a value for this parameter, be sure to specify at least one VPC subnet \n using the VPCZoneIdentifier parameter when you create your Auto Scaling group.
\n \nFor more information, see Auto Scaling in Amazon Virtual Private Cloud\n in the Auto Scaling Developer Guide.
\n \nValid values: default | dedicated
\n\n
\n " @@ -486,7 +536,7 @@ "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " } ], - "documentation": "\n\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n
\n \n\n Creates a new launch configuration. The launch configuration name \n must be unique within the scope of the client's AWS account. The maximum limit\n of launch configurations, which by default is 100, must not yet have been met; otherwise, \n the call will fail. When created, the new launch configuration \n is available for immediate use.\n
\n \nStarting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. \n
\n " + "documentation": "\nStarting with API version 2011-01-01, specifies that the Auto Scaling group will be deleted along with all instances \n associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions \n\t\t associated with the group.\n
\n " } }, "documentation": "\n\n\n
\n " @@ -675,6 +725,42 @@ ], "documentation": "\n\n Deletes the specified LaunchConfiguration.\n
\n\n The specified launch configuration must not be \n attached to an Auto Scaling group. When this call completes,\n the launch configuration is no longer available for use.\n
\nThe name of the lifecycle hook.
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\tThe name of the Auto Scaling group to which the lifecycle hook belongs.
\n ", + "required": true + } + }, + "documentation": "\n \n " + }, + "output": { + "shape_name": "DeleteLifecycleHookAnswer", + "type": "structure", + "members": {}, + "documentation": "\nThe output of the DeleteLifecycleHook action.
\n " + }, + "errors": [], + "documentation": "\n\t\tDeletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).
\n " + }, "DeleteNotificationConfiguration": { "name": "DeleteNotificationConfiguration", "input": { @@ -1048,10 +1134,18 @@ "type": "string", "enum": [ "Pending", + "Pending:Wait", + "Pending:Proceed", "Quarantined", "InService", "Terminating", - "Terminated" + "Terminating:Wait", + "Terminating:Proceed", + "Terminated", + "Detaching", + "Detached", + "EnteringStandby", + "Standby" ], "documentation": "\n\n Contains a description of the current lifecycle state. \n
\nThe Quarantined lifecycle state is currently not used.
\n The NextToken value is invalid.\n
\n Returns a description of each Auto Scaling instance in the InstanceIds list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n
\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n
\n Returns a description of each Auto Scaling instance in the InstanceIds list.\n If a list is not provided, the service returns the full details of all instances up to a maximum of 50. \n By default, the service returns a list of 20 items.\n
\n This action supports pagination by returning a token if there are more pages to retrieve.\n To get the next page, call this action again with the returned token as the NextToken parameter.\n
Returns a list of all notification types supported by Auto Scaling. They are:
\nautoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Describes the available types of lifecycle hooks.
\n " + }, + "DescribeLifecycleHooks": { + "name": "DescribeLifecycleHooks", + "input": { + "shape_name": "DescribeLifecycleHooksType", + "type": "structure", + "members": { + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\t\tThe name of one or more Auto Scaling groups.
\n\t ", + "required": true + }, + "LifecycleHookNames": { + "shape_name": "LifecycleHookNames", + "type": "list", + "members": { + "shape_name": "AsciiStringMaxLen255", + "type": "string", + "pattern": "[A-Za-z0-9\\-_\\/]+", + "min_length": 1, + "max_length": 255, + "documentation": null + }, + "documentation": "\n\t\t\tThe name of one or more lifecycle hooks.
\n\t " + } + }, + "documentation": "\n \n\t\t" + }, + "output": { + "shape_name": "DescribeLifecycleHooksAnswer", + "type": "structure", + "members": { + "LifecycleHooks": { + "shape_name": "LifecycleHooks", + "type": "list", + "members": { + "shape_name": "LifecycleHook", + "type": "structure", + "members": { + "LifecycleHookName": { + "shape_name": "AsciiStringMaxLen255", + "type": "string", + "pattern": "[A-Za-z0-9\\-_\\/]+", + "min_length": 1, + "max_length": 255, + "documentation": "\n\t\t\n\t\t\tThe name of the lifecycle action hook.\n\t\t
\n " + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\t\n\t\t\tThe name of the Auto Scaling group to which the lifecycle action belongs.\n\t\t
\n " + }, + "LifecycleTransition": { + "shape_name": "LifecycleTransition", + "type": "string", + "documentation": "\n\t\tThe Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHooks for a list of available lifecycle hook types.
\n " + }, + "NotificationTargetARN": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\tThe ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either \n\t\tan SQS queue or an SNS topic. The notification message sent to the target will include:
\n\t\tThe ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.
\n " + }, + "NotificationMetadata": { + "shape_name": "XmlStringMaxLen1023", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1023, + "documentation": "\n\t\tContains additional information that you want to include any time Auto Scaling sends a message to the notification target.
\n " + }, + "HeartbeatTimeout": { + "shape_name": "HeartbeatTimeout", + "type": "integer", + "documentation": "\n\t\tDefines the amount of time that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the \n\t\tDefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.
The maximum length of time an instance can remain in a Pending:Wait or Terminating:Wait state. Currently, this value is set at 48 hours.
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can \n\t\tbe either CONTINUE or ABANDON. The default value for this parameter is CONTINUE.
\n\t\tA lifecycle hook tells Auto Scaling that you want to perform an action when an instance launches or terminates. When you have a lifecycle hook in place, the Auto Scaling group will either:\n\t\t
\n\t\tTo learn more, \n\t\tsee Auto Scaling Pending State and \n\t\tAuto Scaling Terminating State.
\n " + }, + "documentation": "\n\t\t\t\n\t\t\tA list describing the lifecycle hooks that belong to the specified Auto Scaling group.\n\t\t\t
\n\t " + } + }, + "documentation": "\nThe output of the DescribeLifecycleHooks action.
\n\t " + }, + "errors": [], + "documentation": "\n\t\t\n\t\t\tDescribes the lifecycle hooks that currently belong to the specified Auto Scaling group.\n\t\t
\n " + }, "DescribeMetricCollectionTypes": { "name": "DescribeMetricCollectionTypes", "input": null, @@ -1741,7 +1974,7 @@ }, "documentation": "\n\n The MetricCollectionType data type.\n
\n " }, - "documentation": "\nThe list of Metrics collected. The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
The list of Metrics collected. The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
The output of the DescribeMetricCollectionTypes action.
\n " }, "errors": [], - "documentation": "\n\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n
\n\n Returns a list of metrics and a corresponding list \n of granularities for each metric.\n
\nThe GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
\n Returns a list of all termination policies supported by Auto Scaling. \n
\n\n\t\t A list of instances to detach from the Auto Scaling group. You must specify at least one instance ID. \n\t\t
\n\t" + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\t\n\t\t\tThe name of the Auto Scaling group from which to detach instances.\n\t\t
\n\t", + "required": true + }, + "ShouldDecrementDesiredCapacity": { + "shape_name": "ShouldDecrementDesiredCapacity", + "type": "boolean", + "documentation": "\n\t\t\n\t\t\tSpecifies if the detached instance should decrement the desired capacity value for the Auto Scaling group. If set to True, the Auto Scaling \n\t\t\tgroup decrements the desired capacity value by the number of instances detached.\n\t\t
\n Specifies the ID of the activity.\n
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", + "required": true + }, + "Description": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains a friendly, more verbose description of the scaling activity.\n
\n " + }, + "Cause": { + "shape_name": "XmlStringMaxLen1023", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1023, + "documentation": "\n\n Contains the reason the activity was begun.\n
\n ", + "required": true + }, + "StartTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the start time of this activity.\n
\n ", + "required": true + }, + "EndTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the end time of this activity.\n
\n " + }, + "StatusCode": { + "shape_name": "ScalingActivityStatusCode", + "type": "string", + "enum": [ + "WaitingForSpotInstanceRequestId", + "WaitingForSpotInstanceId", + "WaitingForInstanceId", + "PreInService", + "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", + "Successful", + "Failed", + "Cancelled" + ], + "documentation": "\n\n Contains the current status of the activity.\n
\n ", + "required": true + }, + "StatusMessage": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n Contains a friendly, more verbose description of the activity status.\n
\n " + }, + "Progress": { + "shape_name": "Progress", + "type": "integer", + "documentation": "\n\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n
\n " + }, + "Details": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains details of the scaling activity.\n
\n " + } + }, + "documentation": "\n\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n
\n " + }, + "documentation": "\n\t\t\n\t\t\tA list describing the activities related to detaching the instances from the Auto Scaling group.\n\t\t
\n " + } + }, + "documentation": "\n\tThe output of the DetachInstances action.
\n " + }, + "errors": [], + "documentation": "\n\tUsing DetachInstances, you can remove an instance from an Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
To learn more about detaching instances, \n\t\tsee Detach Amazon EC2 Instances From Your Auto Scaling Group.
\n\t\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
\n The list of metrics to disable.\n If no metrics are specified, all metrics are disabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupTerminatingInstances
GroupTotalInstances
\n The list of metrics to collect.\n If no metrics are specified, all metrics are enabled.\n The following metrics are supported:\n
\nGroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
The GroupStandbyInstances metric is not returned by default. You must explicitly request it when calling EnableMetricsCollection.
\n Enables monitoring of group metrics for the\n Auto Scaling group specified in AutoScalingGroupName.\n You can specify the list of enabled metrics with the\n Metrics parameter.\n
\n Auto Scaling metrics collection can be turned on only \n if the InstanceMonitoring flag, \n in the Auto Scaling group's launch configuration, \n is set to True.\n
\n\t\t The instances to move into Standby mode. You must specify at least one instance ID. \n\t\t
\n\t" + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\t\n\t\t\tThe name of the Auto Scaling group from which to move instances into Standby mode.\n\t\t
\n\t", + "required": true + }, + "ShouldDecrementDesiredCapacity": { + "shape_name": "ShouldDecrementDesiredCapacity", + "type": "boolean", + "documentation": "\n\t\t\n\t\t\tSpecifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, \n\t\t\tthe desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.\n\t\t
\n\t", + "required": true + } + }, + "documentation": "\n\t" + }, + "output": { + "shape_name": "EnterStandbyAnswer", + "type": "structure", + "members": { + "Activities": { + "shape_name": "Activities", + "type": "list", + "members": { + "shape_name": "Activity", + "type": "structure", + "members": { + "ActivityId": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Specifies the ID of the activity.\n
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", + "required": true + }, + "Description": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains a friendly, more verbose description of the scaling activity.\n
\n " + }, + "Cause": { + "shape_name": "XmlStringMaxLen1023", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1023, + "documentation": "\n\n Contains the reason the activity was begun.\n
\n ", + "required": true + }, + "StartTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the start time of this activity.\n
\n ", + "required": true + }, + "EndTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the end time of this activity.\n
\n " + }, + "StatusCode": { + "shape_name": "ScalingActivityStatusCode", + "type": "string", + "enum": [ + "WaitingForSpotInstanceRequestId", + "WaitingForSpotInstanceId", + "WaitingForInstanceId", + "PreInService", + "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", + "Successful", + "Failed", + "Cancelled" + ], + "documentation": "\n\n Contains the current status of the activity.\n
\n ", + "required": true + }, + "StatusMessage": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n Contains a friendly, more verbose description of the activity status.\n
\n " + }, + "Progress": { + "shape_name": "Progress", + "type": "integer", + "documentation": "\n\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n
\n " + }, + "Details": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains details of the scaling activity.\n
\n " + } + }, + "documentation": "\n\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n
\n " + }, + "documentation": "\n\t\t\n\t\t\tA list describing the activities related to moving instances into Standby mode.\n\t\t
\n\t" + } + }, + "documentation": "\n\tThe output of the EnterStandby action.
\n\t" + }, + "errors": [], + "documentation": "\n\t\t\n\t\t\tMove instances in an Auto Scaling group into a Standby mode.\n\t\t
\n\tTo learn more about how to put instances into a Standby mode, see Auto Scaling InService State.
\n\t\t\tExecutes the specified policy.
\n " }, + "ExitStandby": { + "name": "ExitStandby", + "input": { + "shape_name": "ExitStandbyQuery", + "type": "structure", + "members": { + "InstanceIds": { + "shape_name": "InstanceIds", + "type": "list", + "members": { + "shape_name": "XmlStringMaxLen16", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 16, + "documentation": null + }, + "documentation": "\n\t\t\n\t\t A list of instances to move out of Standby mode. You must specify at least one instance ID. \n\t\t
\n\t" + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\t\n\t\t\tThe name of the Auto Scaling group from which to move instances out of Standby mode.\n\t\t
\n\t", + "required": true + } + }, + "documentation": "\n\t" + }, + "output": { + "shape_name": "ExitStandbyAnswer", + "type": "structure", + "members": { + "Activities": { + "shape_name": "Activities", + "type": "list", + "members": { + "shape_name": "Activity", + "type": "structure", + "members": { + "ActivityId": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Specifies the ID of the activity.\n
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n The name of the Auto Scaling group.\n
\n ", + "required": true + }, + "Description": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains a friendly, more verbose description of the scaling activity.\n
\n " + }, + "Cause": { + "shape_name": "XmlStringMaxLen1023", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1023, + "documentation": "\n\n Contains the reason the activity was begun.\n
\n ", + "required": true + }, + "StartTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the start time of this activity.\n
\n ", + "required": true + }, + "EndTime": { + "shape_name": "TimestampType", + "type": "timestamp", + "documentation": "\n\n Provides the end time of this activity.\n
\n " + }, + "StatusCode": { + "shape_name": "ScalingActivityStatusCode", + "type": "string", + "enum": [ + "WaitingForSpotInstanceRequestId", + "WaitingForSpotInstanceId", + "WaitingForInstanceId", + "PreInService", + "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", + "Successful", + "Failed", + "Cancelled" + ], + "documentation": "\n\n Contains the current status of the activity.\n
\n ", + "required": true + }, + "StatusMessage": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n Contains a friendly, more verbose description of the activity status.\n
\n " + }, + "Progress": { + "shape_name": "Progress", + "type": "integer", + "documentation": "\n\n Specifies a value between 0 and 100 that indicates the progress of the\n activity.\n
\n " + }, + "Details": { + "shape_name": "XmlString", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "documentation": "\n\n Contains details of the scaling activity.\n
\n " + } + }, + "documentation": "\n\n A scaling Activity is a long-running process that \n represents a change to your AutoScalingGroup, \n such as changing the size of the group. \n It can also be a process to replace an instance, \n or a process to perform any other long-running operations \n supported by the API.\n
\n " + }, + "documentation": "\n\t\tA list describing the activities related to moving instances out of Standby mode.
\n\t" + } + }, + "documentation": "\n\tThe output of the ExitStandby action.
\n\t" + }, + "errors": [], + "documentation": "\n\t\t\n\t\t\tMove an instance out of Standby mode.\n\t\t
\n\tTo learn more about how to put instances that are in a Standby mode back into service, see Auto Scaling InService State.
\n\t\t\tThe name of the lifecycle hook.
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\tThe name of the Auto Scaling group to which you want to assign the lifecycle hook.
\n ", + "required": true + }, + "LifecycleTransition": { + "shape_name": "LifecycleTransition", + "type": "string", + "documentation": "\nThe Amazon EC2 instance state to which you want to attach the lifecycle hook. See DescribeLifecycleHookTypes for a list of available lifecycle hook types.
\nThis parameter is required for new lifecycle hooks, but optional when updating existing hooks.
\nThe ARN of the Amazon IAM role that allows the Auto Scaling group to publish to the specified notification target.
\n\t\tThis parameter is required for new lifecycle hooks, but optional when updating existing hooks.
\n\t\tThe ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either \n\t\tan SQS queue or an SNS topic.
\n\t\tThis parameter is required for new lifecycle hooks, but optional when updating existing hooks.
\n\t\tThe notification message sent to the target will include:
\n\t\tThis operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key/value pair format when sending notifications to an Amazon SNS \n\t\ttopic.
\n\t\tWhen you call this operation, a test message is sent to the notification target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.
Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
\n " + }, + "HeartbeatTimeout": { + "shape_name": "HeartbeatTimeout", + "type": "integer", + "documentation": "\n\t\tDefines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the \n\t\tDefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default value for this parameter is\n\t\t3600 seconds (1 hour).
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can \n\t\tbe either CONTINUE or ABANDON. The default value for this parameter is ABANDON.
The output of the PutLifecycleHook action.
\n " + }, + "errors": [ + { + "shape_name": "LimitExceededFault", + "type": "structure", + "members": { + "message": { + "shape_name": "XmlStringMaxLen255", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 255, + "documentation": "\n\n\n
\n " + } + }, + "documentation": "\n\n The quota for capacity groups or launch configurations\n for this customer has already been reached.\n
\n " + } + ], + "documentation": "\n \t\tCreates or updates a lifecycle hook for an Auto Scaling Group.
\n\t\tA lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the \n\t\tinstance terminates.
\n\t\t\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t
\n\t\t\t\tTo learn more, see Auto Scaling Pending State and \n\t\tAuto Scaling Terminating State.
\n\t\t\t\n Creates or updates a scheduled scaling action for an Auto Scaling group. \n When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value \n remains unchanged in the affected Auto Scaling group.\n
\nFor information on creating or updating a scheduled action for your Auto Scaling group, \n see Scale Based on a Schedule.
\nAuto Scaling supports the date and time expressed in \"YYYY-MM-DDThh:mm:ssZ\" format in UTC/GMT only.
\nThe name of the lifecycle hook.
\n ", + "required": true + }, + "AutoScalingGroupName": { + "shape_name": "ResourceName", + "type": "string", + "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", + "min_length": 1, + "max_length": 1600, + "documentation": "\n\t\tThe name of the Auto Scaling group to which the hook belongs.
\n ", + "required": true + }, + "LifecycleActionToken": { + "shape_name": "LifecycleActionToken", + "type": "string", + "min_length": 36, + "max_length": 36, + "documentation": "\n\t\tA token that uniquely identifies a specific lifecycle action associated with an instance. Auto Scaling sends this token to the notification target you specified when you created the \n\t\tlifecycle hook.
\n ", + "required": true + } + }, + "documentation": " \n " + }, + "output": { + "shape_name": "RecordLifecycleActionHeartbeatAnswer", + "type": "structure", + "members": {}, + "documentation": "\n\tThe output of the RecordLifecycleActionHeartbeat action.
\n " + }, + "errors": [], + "documentation": "\n\t\t\n\t\t\tRecords a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter \n\t\t\tof the PutLifecycleHook operation.\n\t\t
\n\t\t\tThis operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:\n\t\t
\n\t\tTo learn more, see Auto Scaling Pending State and \n\t\tAuto Scaling Terminating State.
\n " + }, "ResumeProcesses": { "name": "ResumeProcesses", "input": { @@ -3185,6 +3963,8 @@ "WaitingForInstanceId", "PreInService", "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", "Successful", "Failed", "Cancelled" diff --git a/botocore/data/aws/cloudfront/2014-05-31.json b/botocore/data/aws/cloudfront/2014-05-31.json index e9972bc9..59efb8f6 100644 --- a/botocore/data/aws/cloudfront/2014-05-31.json +++ b/botocore/data/aws/cloudfront/2014-05-31.json @@ -5603,18 +5603,12 @@ ], "documentation": "\n List origin access identities.\n ", "pagination": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "CloudFrontOriginAccessIdentityList", - "py_input_token": [ - "marker" - ] + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items", + "py_input_token": "marker" } }, "ListDistributions": { @@ -6375,18 +6369,12 @@ ], "documentation": "\n List distributions.\n ", "pagination": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "DistributionList", - "py_input_token": [ - "marker" - ] + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items", + "py_input_token": "marker" } }, "ListInvalidations": { @@ -6536,18 +6524,12 @@ ], "documentation": "\n List invalidation batches.\n ", "pagination": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "InvalidationList", - "py_input_token": [ - "marker" - ] + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items", + "py_input_token": "marker" } }, "ListStreamingDistributions": { @@ -6771,18 +6753,12 @@ ], "documentation": "\n List streaming distributions.\n ", "pagination": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "StreamingDistributionList", - "py_input_token": [ - "marker" - ] + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items", + "py_input_token": "marker" } }, "UpdateCloudFrontOriginAccessIdentity": { @@ -9426,60 +9402,36 @@ }, "pagination": { "ListCloudFrontOriginAccessIdentities": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "CloudFrontOriginAccessIdentityList", - "py_input_token": [ - "marker" - ] + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items", + "py_input_token": "marker" }, "ListDistributions": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "DistributionList", - "py_input_token": [ - "marker" - ] + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items", + "py_input_token": "marker" }, "ListInvalidations": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "InvalidationList", - "py_input_token": [ - "marker" - ] + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items", + "py_input_token": "marker" }, "ListStreamingDistributions": { - "input_token": [ - "Marker" - ], + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", "limit_key": "MaxItems", - "more_results": "IsTruncated", - "output_token": [ - "NextMarker" - ], - "result_key": "StreamingDistributionList", - "py_input_token": [ - "marker" - ] + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items", + "py_input_token": "marker" } }, "retry": { diff --git a/botocore/data/aws/cloudsearch/2013-01-01.json b/botocore/data/aws/cloudsearch/2013-01-01.json index b46b8ea8..d528dd5f 100644 --- a/botocore/data/aws/cloudsearch/2013-01-01.json +++ b/botocore/data/aws/cloudsearch/2013-01-01.json @@ -306,17 +306,17 @@ "Synonyms": { "shape_name": "String", "type": "string", - "documentation": "\nA JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.
\n " + "documentation": "\nA JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", - "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
\n " + "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
\n " + "documentation": "\nA JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.
\n " + "documentation": "\nA JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", - "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
\n " + "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
\n " + "documentation": "\nA JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
The request was rejected because it attempted to reference a resource that does not exist.
\n " } ], - "documentation": "\nConfigures an analysis scheme for a domain. An analysis scheme defines language-specific text processing options for a text field. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.
\n " + "documentation": "\nA JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", - "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
\n " + "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
\n " + "documentation": "\nA JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias.
\n " + "documentation": "\nA JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
\n " }, "Stopwords": { "shape_name": "String", "type": "string", - "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
\n " + "documentation": "\nA JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
\n " + "documentation": "\nA JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
\n \n \nSee the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
", + "documentation": "\nThis is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
\nCloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
\n \n \nSee the CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.
", "operations": { "CreateTrail": { "name": "CreateTrail", @@ -19,12 +19,14 @@ "Name": { "shape_name": "String", "type": "string", - "documentation": "\nSpecifies the name of the trail.
\n \n " + "documentation": "\nSpecifies the name of the trail.
\n \n ", + "required": true }, "S3BucketName": { "shape_name": "String", "type": "string", - "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n " + "documentation": "\nSpecifies the name of the Amazon S3 bucket designated for publishing log files.
\n ", + "required": true }, "S3KeyPrefix": { "shape_name": "String", @@ -40,38 +42,6 @@ "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " - }, - "trail": { - "shape_name": "Trail", - "type": "structure", - "members": { - "Name": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the trail set by calling CreateTrail.
\n " - }, - "S3BucketName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " - }, - "S3KeyPrefix": { - "shape_name": "String", - "type": "string", - "documentation": "\nValue of the Amazon S3 prefix.
\n " - }, - "SnsTopicName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " - }, - "IncludeGlobalServiceEvents": { - "shape_name": "Boolean", - "type": "boolean", - "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " - } - }, - "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\nSpecifies the settings for each trail.
\n " @@ -104,38 +74,6 @@ "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " - }, - "trail": { - "shape_name": "Trail", - "type": "structure", - "members": { - "Name": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the trail set by calling CreateTrail.
\n " - }, - "S3BucketName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " - }, - "S3KeyPrefix": { - "shape_name": "String", - "type": "string", - "documentation": "\nValue of the Amazon S3 prefix.
\n " - }, - "SnsTopicName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " - }, - "IncludeGlobalServiceEvents": { - "shape_name": "Boolean", - "type": "boolean", - "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " - } - }, - "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " @@ -194,15 +132,9 @@ "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" - }, - { - "shape_name": "TrailNotProvidedException", - "type": "structure", - "members": {}, - "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], - "documentation": "\nFrom the command line, use create-subscription.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
\nFrom the command line, use create-subscription.
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
\n \n \n \n " }, "DeleteTrail": { "name": "DeleteTrail", @@ -255,10 +187,10 @@ "type": "string", "documentation": null }, - "documentation": "\nThe list of trails.
\n " + "documentation": "\nThe trail returned.
\n " } }, - "documentation": "\nReturns the list of trails.
\n " + "documentation": "\nReturns information about the trail.
\n " }, "output": { "shape_name": "DescribeTrailsResponse", @@ -305,7 +237,7 @@ "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " }, "errors": [], - "documentation": "\nRetrieves the settings for some or all trails associated with an account.
\n " + "documentation": "\nRetrieves settings for the trail associated with the current region for your account.
\n " }, "GetTrailStatus": { "name": "GetTrailStatus", @@ -360,36 +292,6 @@ "shape_name": "Date", "type": "timestamp", "documentation": "\nSpecifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
\n " - }, - "LatestDeliveryAttemptTime": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " - }, - "LatestNotificationAttemptTime": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " - }, - "LatestNotificationAttemptSucceeded": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " - }, - "LatestDeliveryAttemptSucceeded": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " - }, - "TimeLoggingStarted": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " - }, - "TimeLoggingStopped": { - "shape_name": "String", - "type": "string", - "documentation": "\nScheduled for removal as early as February 15, 2014.
\n " } }, "documentation": "\nReturns the objects or data listed below if successful. Otherwise, returns an error.
\n " @@ -408,7 +310,7 @@ "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" } ], - "documentation": "\nReturns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.
\n \nThe CloudTrail API is currently undergoing revision. This action currently returns both\n new fields and fields slated for removal from the API. The following lists indicate the\n plans for each field:
\n\nList of Members Planned for Ongoing Support
\nList of Members Scheduled for Removal
\nReturns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail.
\n \n \n\n\n " }, "StartLogging": { "name": "StartLogging", @@ -493,7 +395,8 @@ "Name": { "shape_name": "String", "type": "string", - "documentation": "\nSpecifies the name of the trail.
\n " + "documentation": "\nSpecifies the name of the trail.
\n ", + "required": true }, "S3BucketName": { "shape_name": "String", @@ -514,38 +417,6 @@ "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " - }, - "trail": { - "shape_name": "Trail", - "type": "structure", - "members": { - "Name": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the trail set by calling CreateTrail.
\n " - }, - "S3BucketName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " - }, - "S3KeyPrefix": { - "shape_name": "String", - "type": "string", - "documentation": "\nValue of the Amazon S3 prefix.
\n " - }, - "SnsTopicName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " - }, - "IncludeGlobalServiceEvents": { - "shape_name": "Boolean", - "type": "boolean", - "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " - } - }, - "documentation": "\nSupport for passing a Trail object in the CreateTrail or UpdateTrail actions will end as early as February 15, 2014. Instead of the Trail object and its members, use the parameters listed for these actions.
\n " } }, "documentation": "\nSpecifies settings to update for the trail.
\n " @@ -578,38 +449,6 @@ "shape_name": "Boolean", "type": "boolean", "documentation": "\nSpecifies whether the trail is publishing events from global services such as IAM to the log files.
\n " - }, - "trail": { - "shape_name": "Trail", - "type": "structure", - "members": { - "Name": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the trail set by calling CreateTrail.
\n " - }, - "S3BucketName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the Amazon S3 bucket into which CloudTrail delivers your trail files.
\n " - }, - "S3KeyPrefix": { - "shape_name": "String", - "type": "string", - "documentation": "\nValue of the Amazon S3 prefix.
\n " - }, - "SnsTopicName": { - "shape_name": "String", - "type": "string", - "documentation": "\nName of the existing Amazon SNS topic that CloudTrail uses to notify the account owner when new CloudTrail log files have been delivered.
\n " - }, - "IncludeGlobalServiceEvents": { - "shape_name": "Boolean", - "type": "boolean", - "documentation": "\nSet to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
\n " - } - }, - "documentation": "\nRepresents the CloudTrail settings that were updated by calling UpdateTrail.
\n " } }, "documentation": "\n Returns the objects or data listed below if successful. Otherwise, returns an error.\n " @@ -662,15 +501,9 @@ "type": "structure", "members": {}, "documentation": "\n\t\tThis exception is thrown when the provided trail name is not valid.\n\t" - }, - { - "shape_name": "TrailNotProvidedException", - "type": "structure", - "members": {}, - "documentation": "\n\t\tThis exception is thrown when no trail is provided.\n\t" } ], - "documentation": "\nFrom the command line, use update-subscription.
Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket.
\n \nFrom the command line, use update-subscription.
Updates the settings that specify delivery of log files. Changes to a trail do not require\n stopping the CloudTrail service. Use this action to designate an existing bucket for log\n delivery. If the existing bucket has previously been a target for CloudTrail log files,\n an IAM policy exists for the bucket.
\n \n \n " } }, "retry": { diff --git a/botocore/data/aws/cognito-identity/2014-06-30.json b/botocore/data/aws/cognito-identity/2014-06-30.json new file mode 100644 index 00000000..1c55eab4 --- /dev/null +++ b/botocore/data/aws/cognito-identity/2014-06-30.json @@ -0,0 +1,1316 @@ +{ + "api_version": "2014-06-30", + "type": "json", + "json_version": "1.1", + "signature_version": "v4", + "service_full_name": "Amazon Cognito Identity", + "endpoint_prefix": "cognito-identity", + "target_prefix": "AWSCognitoIdentityService", + "xmlnamespace": "http://cognito-identity.amazonaws.com/doc/2014-06-30/", + "documentation": "\nAmazon Cognito is a web service that facilitates the delivery of scoped, temporary credentials\n to mobile devices or other untrusted environments. Amazon Cognito uniquely identifies a device\n or user and supplies the user with a consistent identity throughout the lifetime of an\n application.
\nAmazon Cognito lets users authenticate with third-party identity providers (Facebook, Google, or\n Login with Amazon). As a developer, you decide which identity providers to trust. You can\n also choose to support unauthenticated access from your application. Your users are\n provided with Cognito tokens that uniquely identify their device and any information\n provided about third-party logins.
\n ", + "operations": { + "CreateIdentityPool": { + "name": "CreateIdentityPool", + "input": { + "shape_name": "CreateIdentityPoolInput", + "type": "structure", + "members": { + "IdentityPoolName": { + "shape_name": "IdentityPoolName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w ]+", + "documentation": "\nA string that you provide.
\n ", + "required": true + }, + "AllowUnauthenticatedIdentities": { + "shape_name": "IdentityPoolUnauthenticated", + "type": "boolean", + "documentation": "\nTRUE if the identity pool supports unauthenticated logins.
\n ", + "required": true + }, + "SupportedLoginProviders": { + "shape_name": "IdentityProviders", + "type": "map", + "keys": { + "shape_name": "IdentityProviderName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "members": { + "shape_name": "IdentityProviderId", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "max_length": 3, + "documentation": "\nOptional key:value pairs mapping provider names to provider app IDs.
\n " + } + }, + "documentation": "\nInput to the CreateIdentityPool action.
\n " + }, + "output": { + "shape_name": "IdentityPool", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "An identity pool ID in the format\n REGION:GUID.", + "required": true + }, + "IdentityPoolName": { + "shape_name": "IdentityPoolName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w ]+", + "documentation": "\nA string that you provide.
\n ", + "required": true + }, + "AllowUnauthenticatedIdentities": { + "shape_name": "IdentityPoolUnauthenticated", + "type": "boolean", + "documentation": "TRUE if the identity pool\n supports unauthenticated logins.", + "required": true + }, + "SupportedLoginProviders": { + "shape_name": "IdentityProviders", + "type": "map", + "keys": { + "shape_name": "IdentityProviderName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "members": { + "shape_name": "IdentityProviderId", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "max_length": 3, + "documentation": "\nOptional key:value pairs mapping provider names to provider app IDs.
\n " + } + }, + "documentation": "An object representing a Cognito identity\n pool." + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InvalidParameterException." + } + }, + "documentation": "Thrown for missing or bad input\n parameter(s)." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException" + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "ResourceConflictException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n ResourceConflictException." + } + }, + "documentation": "Thrown when a user tries to use a login which\n is already linked to another account." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException" + } + }, + "documentation": "Thrown when a request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InternalErrorException." + } + }, + "documentation": "Thrown when the service encounters an error during\n processing the request." + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n LimitExceededException." + } + }, + "documentation": "Thrown when the total number of user pools has\n exceeded a preset limit." + } + ], + "documentation": "\nCreates a new identity pool. The identity pool is a store of user identity information that\n is specific to your AWS account.
\nInput to the DeleteIdentityPool action.
\n " + }, + "output": null, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InvalidParameterException." + } + }, + "documentation": "Thrown for missing or bad input\n parameter(s)." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n ResourceNotFoundException." + } + }, + "documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException" + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException" + } + }, + "documentation": "Thrown when a request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InternalErrorException." + } + }, + "documentation": "Thrown when the service encounters an error during\n processing the request." + } + ], + "documentation": "\nDeletes a user pool. Once a pool is deleted, users will not be able to authenticate with\n the pool.
\nA string that you provide.
\n ", + "required": true + }, + "AllowUnauthenticatedIdentities": { + "shape_name": "IdentityPoolUnauthenticated", + "type": "boolean", + "documentation": "TRUE if the identity pool\n supports unauthenticated logins.", + "required": true + }, + "SupportedLoginProviders": { + "shape_name": "IdentityProviders", + "type": "map", + "keys": { + "shape_name": "IdentityProviderName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "members": { + "shape_name": "IdentityProviderId", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "max_length": 3, + "documentation": "\nOptional key:value pairs mapping provider names to provider app IDs.
\n " + } + }, + "documentation": "An object representing a Cognito identity\n pool." + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InvalidParameterException." + } + }, + "documentation": "Thrown for missing or bad input\n parameter(s)." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n ResourceNotFoundException." + } + }, + "documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException" + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException" + } + }, + "documentation": "Thrown when a request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InternalErrorException." + } + }, + "documentation": "Thrown when the service encounters an error during\n processing the request." + } + ], + "documentation": "\nGets details about a particular identity pool, including the pool name, ID description,\n creation date, and current number of users.
\nGenerates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit\n linked account.
\nGets an OpenID token, using a known Cognito ID. This known Cognito ID is returned from\n GetId. You can optionally add additional logins for the identity. Supplying multiple logins\n creates an implicit link.
\nLists the identities in a pool.
\nLists all of the Cognito identity pools registered for your account.
\nUnlinks a federated identity from an existing account. Unlinked logins will be considered\n new identities next time they are seen. Removing the last linked login will make this\n identity inaccessible.
\n " + }, + "UpdateIdentityPool": { + "name": "UpdateIdentityPool", + "input": { + "shape_name": "IdentityPool", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "An identity pool ID in the format\n REGION:GUID.", + "required": true + }, + "IdentityPoolName": { + "shape_name": "IdentityPoolName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w ]+", + "documentation": "\nA string that you provide.
\n ", + "required": true + }, + "AllowUnauthenticatedIdentities": { + "shape_name": "IdentityPoolUnauthenticated", + "type": "boolean", + "documentation": "TRUE if the identity pool\n supports unauthenticated logins.", + "required": true + }, + "SupportedLoginProviders": { + "shape_name": "IdentityProviders", + "type": "map", + "keys": { + "shape_name": "IdentityProviderName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "members": { + "shape_name": "IdentityProviderId", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "max_length": 3, + "documentation": "\nOptional key:value pairs mapping provider names to provider app IDs.
\n " + } + }, + "documentation": "An object representing a Cognito identity\n pool." + }, + "output": { + "shape_name": "IdentityPool", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "An identity pool ID in the format\n REGION:GUID.", + "required": true + }, + "IdentityPoolName": { + "shape_name": "IdentityPoolName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w ]+", + "documentation": "\nA string that you provide.
\n ", + "required": true + }, + "AllowUnauthenticatedIdentities": { + "shape_name": "IdentityPoolUnauthenticated", + "type": "boolean", + "documentation": "TRUE if the identity pool\n supports unauthenticated logins.", + "required": true + }, + "SupportedLoginProviders": { + "shape_name": "IdentityProviders", + "type": "map", + "keys": { + "shape_name": "IdentityProviderName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "members": { + "shape_name": "IdentityProviderId", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[\\w._-]+", + "documentation": null + }, + "max_length": 3, + "documentation": "\nOptional key:value pairs mapping provider names to provider app IDs.
\n " + } + }, + "documentation": "An object representing a Cognito identity\n pool." + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InvalidParameterException." + } + }, + "documentation": "Thrown for missing or bad input\n parameter(s)." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n ResourceNotFoundException." + } + }, + "documentation": "Thrown when the requested resource (for\n example, a dataset or record) does not exist." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException" + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "ResourceConflictException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by a\n ResourceConflictException." + } + }, + "documentation": "Thrown when a user tries to use a login which\n is already linked to another account." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException" + } + }, + "documentation": "Thrown when a request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "String", + "type": "string", + "documentation": "The message returned by an\n InternalErrorException." + } + }, + "documentation": "Thrown when the service encounters an error during\n processing the request." + } + ], + "documentation": "\nUpdates a user pool.
\nAmazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of\n application-related user data. High-level client libraries are available for both iOS and\n Android. You can use these libraries to persist data locally so that it's available even if\n the device is offline. Developer credentials don't need to be stored on the mobile device\n to access the service. You can use Amazon Cognito to obtain a normalized user ID and\n credentials. User data is persisted in a dataset that can store up to 1 MB of key-value\n pairs, and you can have up to 20 datasets per user identity.
\n ", + "operations": { + "DeleteDataset": { + "name": "DeleteDataset", + "http": { + "method": "DELETE", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "response_code": 200 + }, + "input": { + "shape_name": "DeleteDatasetRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).", + "required": true, + "location": "uri" + } + }, + "documentation": "A request to delete the specific\n dataset." + }, + "output": { + "shape_name": "DeleteDatasetResponse", + "type": "structure", + "members": { + "Dataset": { + "shape_name": "Dataset", + "type": "structure", + "members": { + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "CreationDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date when the dataset was last\n modified." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": "The device that made the last change to this\n dataset." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Total size in bytes of the records in this\n dataset." + }, + "NumRecords": { + "shape_name": "Long", + "type": "long", + "documentation": "Number of records in this dataset." + } + }, + "documentation": "A collection of data for an identity pool.\n An identity pool can have multiple datasets. A dataset is per identity and can be general or\n associated with a particular entity in an application (like a saved game). Datasets are\n automatically created if they don't exist. Data is synced by dataset, and a dataset can hold\n up to 1MB of key-value pairs." + } + }, + "documentation": "Response to a successful DeleteDataset\n request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n ResourceNotFoundException.", + "required": true + } + }, + "documentation": "Thrown if the resource doesn't\n exist." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Deletes the specific dataset. The dataset will be deleted\n permanently, and the action can't be undone. Datasets that this dataset was merged with will\n no longer report the merge. Any consequent operation on this dataset will result in a\n ResourceNotFoundException." + }, + "DescribeDataset": { + "name": "DescribeDataset", + "http": { + "method": "GET", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "response_code": 200 + }, + "input": { + "shape_name": "DescribeDatasetRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).", + "required": true, + "location": "uri" + } + }, + "documentation": "A request for metadata about a dataset (creation\n date, number of records, size) by owner and dataset name." + }, + "output": { + "shape_name": "DescribeDatasetResponse", + "type": "structure", + "members": { + "Dataset": { + "shape_name": "Dataset", + "type": "structure", + "members": { + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "CreationDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date when the dataset was last\n modified." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": "The device that made the last change to this\n dataset." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Total size in bytes of the records in this\n dataset." + }, + "NumRecords": { + "shape_name": "Long", + "type": "long", + "documentation": "Number of records in this dataset." + } + }, + "documentation": "Metadata for a collection of data for an\n identity. An identity can have multiple datasets. A dataset can be general or associated with\n a particular entity in an application (like a saved game). Datasets are automatically created\n if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value\n pairs." + } + }, + "documentation": "Response to a successful DescribeDataset\n request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n ResourceNotFoundException.", + "required": true + } + }, + "documentation": "Thrown if the resource doesn't\n exist." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Gets metadata about a dataset by identity and dataset\n name. " + }, + "DescribeIdentityPoolUsage": { + "name": "DescribeIdentityPoolUsage", + "http": { + "method": "GET", + "uri": "/identitypools/{IdentityPoolId}", + "response_code": 200 + }, + "input": { + "shape_name": "DescribeIdentityPoolUsageRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for\n example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID\n generation is unique within a region.", + "required": true, + "location": "uri" + } + }, + "documentation": "A request for usage information about\n the identity pool." + }, + "output": { + "shape_name": "DescribeIdentityPoolUsageResponse", + "type": "structure", + "members": { + "IdentityPoolUsage": { + "shape_name": "IdentityPoolUsage", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "SyncSessionsCount": { + "shape_name": "Long", + "type": "long", + "documentation": "Number of sync sessions for the\n identity pool." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Data storage information for the identity\n pool." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date on which the identity pool was\n last modified." + } + }, + "documentation": "Information about the\n usage of the identity pool." + } + }, + "documentation": "Response to a successful\n DescribeIdentityPoolUsage request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n ResourceNotFoundException.", + "required": true + } + }, + "documentation": "Thrown if the resource doesn't\n exist." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Gets usage details (for example, data storage) about\n a particular identity pool." + }, + "DescribeIdentityUsage": { + "name": "DescribeIdentityUsage", + "http": { + "method": "GET", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}", + "response_code": 200 + }, + "input": { + "shape_name": "DescribeIdentityUsageRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for\n example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID\n generation is unique within a region.", + "required": true, + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + } + }, + "documentation": "A request for information about the usage of\n an identity pool." + }, + "output": { + "shape_name": "DescribeIdentityUsageResponse", + "type": "structure", + "members": { + "IdentityUsage": { + "shape_name": "IdentityUsage", + "type": "structure", + "members": { + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date on which the identity was last\n modified." + }, + "DatasetCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "Number of datasets for the\n identity." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Total data storage for this\n identity." + } + }, + "documentation": "Usage information for the\n identity." + } + }, + "documentation": "The response to a successful\n DescribeIdentityUsage request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n ResourceNotFoundException.", + "required": true + } + }, + "documentation": "Thrown if the resource doesn't\n exist." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Gets usage information for an identity, including\n number of datasets and data usage. " + }, + "ListDatasets": { + "name": "ListDatasets", + "http": { + "method": "GET", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets?maxResults={MaxResults}&nextToken={NextToken}", + "response_code": 200 + }, + "input": { + "shape_name": "ListDatasetsRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining the next\n page of results. ", + "location": "uri" + }, + "MaxResults": { + "shape_name": "IntegerString", + "type": "integer", + "documentation": "The maximum number of results to be\n returned.", + "location": "uri" + } + }, + "documentation": "Request for a list of datasets for an\n identity." + }, + "output": { + "shape_name": "ListDatasetsResponse", + "type": "structure", + "members": { + "Datasets": { + "shape_name": "DatasetList", + "type": "list", + "members": { + "shape_name": "Dataset", + "type": "structure", + "members": { + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters. Allowed characters\n are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "CreationDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date when the dataset was last\n modified." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": "The device that made the last change to this\n dataset." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Total size in bytes of the records in this\n dataset." + }, + "NumRecords": { + "shape_name": "Long", + "type": "long", + "documentation": "Number of records in this dataset." + } + }, + "documentation": "A collection of data for an identity pool. An identity pool can\n have multiple datasets. A dataset is per identity and can be general or associated with a\n particular entity in an application (like a saved game). Datasets are automatically created if\n they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value\n pairs." + }, + "documentation": "A set of datasets." + }, + "Count": { + "shape_name": "Integer", + "type": "integer", + "documentation": "Number of datasets returned." + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining the next\n page of results." + } + }, + "documentation": "Returned for a successful ListDatasets\n request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Lists datasets for an identity." + }, + "ListIdentityPoolUsage": { + "name": "ListIdentityPoolUsage", + "http": { + "method": "GET", + "uri": "/identitypools?maxResults={MaxResults}&nextToken={NextToken}", + "response_code": 200 + }, + "input": { + "shape_name": "ListIdentityPoolUsageRequest", + "type": "structure", + "members": { + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining\n the next page of results. ", + "location": "uri" + }, + "MaxResults": { + "shape_name": "IntegerString", + "type": "integer", + "documentation": "The maximum number of results to\n be returned.", + "location": "uri" + } + }, + "documentation": "A request for usage information on an\n identity pool." + }, + "output": { + "shape_name": "ListIdentityPoolUsageResponse", + "type": "structure", + "members": { + "IdentityPoolUsages": { + "shape_name": "IdentityPoolUsageList", + "type": "list", + "members": { + "shape_name": "IdentityPoolUsage", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region." + }, + "SyncSessionsCount": { + "shape_name": "Long", + "type": "long", + "documentation": "Number of sync sessions for the\n identity pool." + }, + "DataStorage": { + "shape_name": "Long", + "type": "long", + "documentation": "Data storage information for the identity\n pool." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "Date on which the identity pool was\n last modified." + } + }, + "documentation": "Usage information for the identity\n pool." + }, + "documentation": "Usage information for\n the identity pools." + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "The maximum number of results to\n be returned." + }, + "Count": { + "shape_name": "Integer", + "type": "integer", + "documentation": "Total number of identities for the\n identity pool." + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining\n the next page of results." + } + }, + "documentation": "Returned for a successful\n ListIdentityPoolUsage request." + }, + "errors": [ + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Gets a list of identity pools registered with\n Cognito." + }, + "ListRecords": { + "name": "ListRecords", + "http": { + "method": "GET", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records?lastSyncCount={LastSyncCount}&maxResults={MaxResults}&nextToken={NextToken}&syncSessionToken={SyncSessionToken}", + "response_code": 200 + }, + "input": { + "shape_name": "ListRecordsRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters. Allowed\n characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).", + "required": true, + "location": "uri" + }, + "LastSyncCount": { + "shape_name": "IntegerString", + "type": "long", + "documentation": "The last server sync count for this record.", + "location": "uri" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining the next\n page of results.", + "location": "uri" + }, + "MaxResults": { + "shape_name": "IntegerString", + "type": "integer", + "documentation": "The maximum number of results to be\n returned.", + "location": "uri" + }, + "SyncSessionToken": { + "shape_name": "SyncSessionToken", + "type": "string", + "documentation": "A token containing a session ID, identity ID, and expiration.", + "location": "uri" + } + }, + "documentation": "A request for a list of records." + }, + "output": { + "shape_name": "ListRecordsResponse", + "type": "structure", + "members": { + "Records": { + "shape_name": "RecordList", + "type": "list", + "members": { + "shape_name": "Record", + "type": "structure", + "members": { + "Key": { + "shape_name": "RecordKey", + "type": "string", + "min_length": 1, + "max_length": 1024, + "documentation": "The key for the record." + }, + "Value": { + "shape_name": "RecordValue", + "type": "string", + "max_length": 1048575, + "documentation": "The value for the record." + }, + "SyncCount": { + "shape_name": "Long", + "type": "long", + "documentation": "The server sync count for this record." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "The date on which the record was last\n modified." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": "The user/device that made the last change to this\n record." + }, + "DeviceLastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "The last modified date of the client device." + } + }, + "documentation": "The basic data structure of a dataset." + }, + "documentation": "A list of all records." + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "A pagination token for obtaining the next\n page of results." + }, + "Count": { + "shape_name": "Integer", + "type": "integer", + "documentation": "Total number of records." + }, + "DatasetSyncCount": { + "shape_name": "Long", + "type": "long", + "documentation": "Server sync count for this dataset." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": null + }, + "MergedDatasetNames": { + "shape_name": "MergedDatasetNameList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null + }, + "documentation": "Names of merged\n datasets." + }, + "DatasetExists": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "Indicates whether the dataset\n exists." + }, + "DatasetDeletedAfterRequestedSyncCount": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "A boolean value\n specifying whether to delete the dataset locally." + }, + "SyncSessionToken": { + "shape_name": "String", + "type": "string", + "documentation": "A token containing a session ID, identity ID, and expiration." + } + }, + "documentation": "Returned for a successful\n ListRecordsRequest." + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException.", + "required": true + } + }, + "documentation": "Thrown if the request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Gets paginated records, optionally changed after a particular\n sync count for a dataset and identity." + }, + "UpdateRecords": { + "name": "UpdateRecords", + "http": { + "method": "POST", + "uri": "/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "response_code": 200 + }, + "input": { + "shape_name": "UpdateRecordsRequest", + "type": "structure", + "members": { + "IdentityPoolId": { + "shape_name": "IdentityPoolId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "IdentityId": { + "shape_name": "IdentityId", + "type": "string", + "pattern": "[\\w-]+:[0-9a-f-]+", + "min_length": 1, + "max_length": 50, + "documentation": "A name-spaced GUID (for example,\n us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is\n unique within a region.", + "required": true, + "location": "uri" + }, + "DatasetName": { + "shape_name": "DatasetName", + "type": "string", + "min_length": 1, + "max_length": 128, + "pattern": "[a-zA-Z0-9_.:-]+", + "documentation": "A string of up to 128 characters.\n Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.'\n (dot).", + "required": true, + "location": "uri" + }, + "RecordPatches": { + "shape_name": "RecordPatchList", + "type": "list", + "members": { + "shape_name": "RecordPatch", + "type": "structure", + "members": { + "Op": { + "shape_name": "Operation", + "type": "string", + "enum": [ + "replace", + "remove" + ], + "documentation": "An operation, either replace or remove.", + "required": true + }, + "Key": { + "shape_name": "RecordKey", + "type": "string", + "min_length": 1, + "max_length": 1024, + "documentation": "The key associated with the record patch.", + "required": true + }, + "Value": { + "shape_name": "RecordValue", + "type": "string", + "max_length": 1048575, + "documentation": "The value associated with the record\n patch." + }, + "SyncCount": { + "shape_name": "Long", + "type": "long", + "documentation": "Last known server sync count for this record. Set to 0 if unknown.", + "required": true + }, + "DeviceLastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "The last modified date of the client device." + } + }, + "documentation": "An update operation for a record." + }, + "documentation": " " + }, + "SyncSessionToken": { + "shape_name": "SyncSessionToken", + "type": "string", + "documentation": "The SyncSessionToken returned by a\n previous call to ListRecords for this dataset and identity.", + "required": true + }, + "ClientContext": { + "shape_name": "ClientContext", + "type": "string", + "documentation": null, + "location": "header", + "location_name": "x-amz-Client-Context" + } + }, + "documentation": "A request to post updates to records or add and\n delete records for a dataset and user." + }, + "output": { + "shape_name": "UpdateRecordsResponse", + "type": "structure", + "members": { + "Records": { + "shape_name": "RecordList", + "type": "list", + "members": { + "shape_name": "Record", + "type": "structure", + "members": { + "Key": { + "shape_name": "RecordKey", + "type": "string", + "min_length": 1, + "max_length": 1024, + "documentation": "The key for the record." + }, + "Value": { + "shape_name": "RecordValue", + "type": "string", + "max_length": 1048575, + "documentation": "The value for the record." + }, + "SyncCount": { + "shape_name": "Long", + "type": "long", + "documentation": "The server sync count for this record." + }, + "LastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "The date on which the record was last\n modified." + }, + "LastModifiedBy": { + "shape_name": "String", + "type": "string", + "documentation": "The user/device that made the last change to this\n record." + }, + "DeviceLastModifiedDate": { + "shape_name": "Date", + "type": "timestamp", + "documentation": "The last modified date of the client device." + } + }, + "documentation": "The basic data structure of a dataset." + }, + "documentation": "A list of records that have been\n updated." + } + }, + "documentation": "Returned for a successful\n UpdateRecordsRequest." + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InvalidParameterException.", + "required": true + } + }, + "documentation": "Thrown when a request parameter does not comply\n with the associated constraints." + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n LimitExceededException.", + "required": true + } + }, + "documentation": "Thrown when the limit on the number of objects or\n operations has been exceeded." + }, + { + "shape_name": "NotAuthorizedException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n NotAuthorizedException.", + "required": true + } + }, + "documentation": "Thrown when a user is not authorized to access the\n requested resource." + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n ResourceNotFoundException.", + "required": true + } + }, + "documentation": "Thrown if the resource doesn't\n exist." + }, + { + "shape_name": "ResourceConflictException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "The message returned by a\n ResourceConflictException.", + "required": true + } + }, + "documentation": "Thrown if an update can't be applied because\n the resource was changed by another call and this would result in a conflict." + }, + { + "shape_name": "TooManyRequestsException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by a\n TooManyRequestsException.", + "required": true + } + }, + "documentation": "Thrown if the request is\n throttled." + }, + { + "shape_name": "InternalErrorException", + "type": "structure", + "members": { + "message": { + "shape_name": "ExceptionMessage", + "type": "string", + "documentation": "Message returned by\n InternalErrorException.", + "required": true + } + }, + "documentation": "Indicates an internal service\n error." + } + ], + "documentation": "Posts updates to records and add and delete records for a\n dataset and user." + } + }, + "retry": { + "__default__": { + "max_attempts": 5, + "delay": { + "type": "exponential", + "base": "rand", + "growth_factor": 2 + }, + "policies": { + "general_socket_errors": { + "applies_when": { + "socket_errors": [ + "GENERAL_CONNECTION_ERROR" + ] + } + }, + "general_server_error": { + "applies_when": { + "response": { + "http_status_code": 500 + } + } + }, + "service_unavailable": { + "applies_when": { + "response": { + "http_status_code": 503 + } + } + }, + "limit_exceeded": { + "applies_when": { + "response": { + "http_status_code": 509 + } + } + } + } + } + } +} \ No newline at end of file diff --git a/botocore/data/aws/dynamodb/2012-08-10.json b/botocore/data/aws/dynamodb/2012-08-10.json index dbfa0b84..ff2fbf8d 100644 --- a/botocore/data/aws/dynamodb/2012-08-10.json +++ b/botocore/data/aws/dynamodb/2012-08-10.json @@ -4798,6 +4798,11 @@ "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": "Items", + "non_aggregate_keys": [ + "Count", + "ScannedCount", + "ConsumedCapacity" + ], "py_input_token": "exclusive_start_key" } }, @@ -5314,6 +5319,11 @@ "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": "Items", + "non_aggregate_keys": [ + "Count", + "ScannedCount", + "ConsumedCapacity" + ], "py_input_token": "exclusive_start_key" } }, @@ -6500,6 +6510,11 @@ "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": "Items", + "non_aggregate_keys": [ + "Count", + "ScannedCount", + "ConsumedCapacity" + ], "py_input_token": "exclusive_start_key" }, "Scan": { @@ -6507,6 +6522,11 @@ "output_token": "LastEvaluatedKey", "limit_key": "Limit", "result_key": "Items", + "non_aggregate_keys": [ + "Count", + "ScannedCount", + "ConsumedCapacity" + ], "py_input_token": "exclusive_start_key" } }, diff --git a/botocore/data/aws/ec2/2014-06-15.json b/botocore/data/aws/ec2/2014-06-15.json new file mode 100644 index 00000000..5c4d22ae --- /dev/null +++ b/botocore/data/aws/ec2/2014-06-15.json @@ -0,0 +1,20936 @@ +{ + "api_version": "2014-06-15", + "type": "query", + "result_wrapped": false, + "signature_version": "v2", + "service_full_name": "Amazon Elastic Compute Cloud", + "service_abbreviation": "Amazon EC2", + "endpoint_prefix": "ec2", + "xmlnamespace": "http://ec2.amazonaws.com/doc/2014-06-15/", + "documentation": "\n\t\tAmazon Elastic Compute Cloud (Amazon EC2) provides resizable computing\n capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates\n your need to invest in hardware up front, so you can develop and deploy\n applications faster.
\n ", + "operations": { + "AcceptVpcPeeringConnection": { + "name": "AcceptVpcPeeringConnection", + "input": { + "shape_name": "AcceptVpcPeeringConnectionRequest", + "type": "structure", + "members": { + "DryRun": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n " + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "AcceptVpcPeeringConnectionResult", + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape_name": "VpcPeeringConnection", + "type": "structure", + "members": { + "AccepterVpcInfo": { + "shape_name": "VpcPeeringConnectionVpcInfo", + "type": "structure", + "members": { + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the peer VPC.
\n ", + "xmlname": "accepterVpcInfo" + }, + "ExpirationTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time that an unaccepted VPC peering connection will expire.
\n ", + "xmlname": "expirationTime" + }, + "RequesterVpcInfo": { + "shape_name": "VpcPeeringConnectionVpcInfo", + "type": "structure", + "members": { + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the requester VPC.
\n ", + "xmlname": "requesterVpcInfo" + }, + "Status": { + "shape_name": "VpcPeeringConnectionStateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nA message that provides more information about the status, if applicable.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "status" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnectionId" + } + }, + "documentation": "\nInformation about the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnection" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nAccept a VPC peering connection request. To accept a request, the VPC peering connection\n must be in the pending-acceptance state, and you must be the owner of\n the peer VPC. Use the DescribeVpcPeeringConnections request to\n view your outstanding VPC peering connection requests.
Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "AllocateAddressResult", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Elastic IP address.
\n ", + "xmlname": "publicIp" + }, + "Domain": { + "shape_name": "DomainType", + "type": "string", + "enum": [ + "vpc", + "standard" + ], + "documentation": "\nIndicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).
[EC2-VPC] The ID that AWS assigns to represent the allocation of\n\t\t\t\tthe Elastic IP address for use with instances in a VPC.
\n ", + "xmlname": "allocationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nAcquires an Elastic IP address.
\nAn Elastic IP address is for use either in the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the network interface.
\n ", + "required": true + }, + "PrivateIpAddresses": { + "shape_name": "PrivateIpAddressStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "PrivateIpAddress" + }, + "documentation": "\nOne or more IP addresses to be assigned as a secondary private IP address to\n\t\t\t\tthe network interface.
\n\t\tIf you don't specify an IP address, Amazon EC2 automatically\n\t\t\t\tselects an IP address within the subnet range.
\n ", + "flattened": true + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of secondary IP addresses to assign to the network interface.
\n " + }, + "AllowReassignment": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether to allow an IP address that is already assigned\n\t\t\t\tto another network interface or instance to be reassigned to the\n\t\t\t\tspecified network interface.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nAssigns one or more secondary private IP addresses to the specified network interface. You\n\t\t\t\tcan specify one or more specific secondary IP addresses, or\n\t\t\t\tyou can specify the number of secondary IP addresses to be automatically assigned\n\t\t\t\twithin the subnet's CIDR block range. The number of secondary IP addresses that you\n\t\t\t\tcan assign to an instance varies by instance type. For information about\n\t\t\t\tinstance types, see Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP\n\t\t\t\taddresses, see Elastic IP\n\t\t\t\tAddresses in the Amazon Elastic Compute Cloud User Guide.
\nAssignPrivateIpAddresses is available only in EC2-VPC.
\n10.0.2.1 and\n\t\t\t\t\t10.0.2.11) to the specified network interface.The ID of the instance. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.
\n " + }, + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Elastic IP address.
\n " + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The allocation ID. This is required for EC2-VPC.
\n " + }, + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The ID of the network interface. If the instance has more than one \n network interface, you must specify a network interface ID.
\n " + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The primary or secondary private IP address to associate\n\t\t\t\twith the Elastic IP address. If no private IP address is specified, the\n\t\t\t\tElastic IP address is associated with the primary private IP\n\t\t\t\taddress.
\n " + }, + "AllowReassociation": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n[EC2-VPC] Allows an Elastic IP address that is already associated\n\t\t\t\twith an instance or network interface to be re-associated with the\n\t\t\t\tspecified instance or network interface. Otherwise, the operation\n\t\t\t\tfails.
\nDefault: false
[EC2-VPC] The ID that represents the association of the Elastic IP\n\t\t\t\taddress with an instance.
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nAssociates an Elastic IP address with an instance or a network interface.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n[EC2-Classic, default VPC] If the Elastic IP address is already associated with a different\n\t\t\t\tinstance, it is disassociated from that instance and associated with the specified\n\t\t\t\tinstance.
\n[EC2-VPC] If you don't specify a private IP address, the Elastic IP address is\n\t\t\t\tassociated with the primary IP address. If the Elastic IP address is already\n\t\t\t\tassociated with a different instance or a network interface, you get an error unless\n\t\t\t\tyou allow reassociation.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.
\nAllowReassignment parameter allows the Elastic IP address to be associated with \n\t\t\t\t\tthe specified instance even if it's already associated with a different instance or a network interface.The ID of the DHCP options set, or default to associate \n no DHCP options with the VPC.
The ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tAssociates a set of DHCP options (that you've previously created) with the\n\t\t\t specified VPC, or associates no DHCP options with the VPC.
\n\t\tAfter you associate the options with the VPC, any existing instances and all new\n \t\t\t instances that you launch in that VPC use the options. You don't need to restart or\n\t \t\t relaunch the instances. They automatically pick up the changes within a few hours,\n\t\t \t depending on how frequently the instance renews its DHCP lease. You can\n\t\t\t explicitly renew the lease using the operating system on the instance.
\n\t\tFor more information,\n\t\t\t see DHCP Options Sets \n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\ndopt-7a8b9c2d with the VPC\n\t\t\t\t\twith the ID vpc-1a2b3c4d.vpc-1a2b3c4d to have no \n\t\t\t\t\tassociated DHCP options set.The ID of the subnet.
\n ", + "required": true + }, + "RouteTableId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the route table.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "AssociateRouteTableResult", + "type": "structure", + "members": { + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe route table association ID (needed to disassociate the route table).
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nAssociates a subnet with a route table. The subnet and route table must be in the same VPC.\n\t\t\t\tThis association causes traffic originating from the subnet to be routed according\n\t\t\t\tto the routes in the route table. The action returns an association ID, which you\n\t\t\t\tneed in order to disassociate the route table from the subnet later. A route table\n\t\t\t\tcan be associated with multiple subnets.
\n\t\tFor more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nrtb-e4ad488d with a subnet with\n\t\t\t\t\tthe ID subnet-15ad487c.The ID of the Internet gateway.
\n ", + "required": true + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tAttaches an Internet gateway to a VPC, enabling connectivity between the Internet\n\t\t\t\tand the VPC. For more information about your VPC and Internet gateway, see the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nigw-eaad4883 to the VPC with\n\t\t\t\t\tthe ID vpc-11ad4878.The ID of the network interface.
\n ", + "required": true + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the instance.
\n ", + "required": true + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device for the network interface attachment.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "AttachNetworkInterfaceResult", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tAttaches a network interface to an instance.
\nThe ID of the Amazon EBS volume. The volume and instance must be within the same Availability\n Zone.
\n ", + "required": true + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "required": true + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name to expose to the instance (for example, /dev/sdh or\n xvdh).
The ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name.
\n ", + "xmlname": "device" + }, + "State": { + "shape_name": "VolumeAttachmentState", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state of the volume.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n ", + "xmlname": "attachment" + }, + "errors": [], + "documentation": "\nAttaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance\n with the specified device name.
\nEncrypted Amazon EBS volumes may only be attached to\n instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the\n Amazon Elastic Compute Cloud User Guide.
\nFor a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved\n for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the\n Amazon Elastic Compute Cloud User Guide.
\nIf a volume has an AWS Marketplace product code:
\nFor an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS\n Marketplace, see AWS Marketplace.
\nFor more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the\n Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d to\n the instance with the ID i-1a2b3c4d and exposes it as\n /dev/sdh.The ID of the virtual private gateway.
\n ", + "required": true + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "AttachVpnGatewayResult", + "type": "structure", + "members": { + "VpcAttachment": { + "shape_name": "VpcAttachment", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe current state of the attachment.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tInformation about the attachment.
\n ", + "xmlname": "attachment" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tAttaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway\n\t\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvgw-8db04f81 to the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.The ID of the security group.
\n ", + "required": true + }, + "SourceSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "SourceSecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " + }, + "IpPermissions": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n " + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "Groups" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "flattened": true + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n " + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "flattened": true + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n " + }, + "documentation": "\n \n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nAdds one or more egress rules to a security group for use with a VPC.\n\t\t\t\tSpecifically, this action permits instances to send traffic to one or more\n\t\t\t\tCIDR IP address ranges, or to one or more security groups\tfor the same VPC.
\n\t\t\tYou can have up to 50 rules per security group (covering both ingress and\n\t\t\t\t\tegress rules).
\n\t\t\tA security group is for use with instances either in the EC2-Classic platform or in a specific VPC.\n\t\t\t\tThis action doesn't apply to security groups for use in EC2-Classic. \n\t\t\t\tFor more information, see Security Groups for Your VPC in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nEach rule consists of the protocol (for example, TCP), plus either a CIDR range or\n\t\t\t\ta source group. For the TCP and UDP protocols, you must also specify the destination\n\t\t\t\tport or port range. For the ICMP protocol, you must also specify the ICMP type and\n\t\t\t\tcode. You can use -1 for the type or code to mean all types or all codes.
\nRule changes are propagated to affected instances as quickly as possible. However,\n\t\t\t\ta small delay might occur.
\nsg-1a2b3c4d access to the\n\t\t\t\t\t192.0.2.0/24 and 198.51.100.0/24 address ranges on TCP port 80.sg-1a2b3c4d \n\t\t\t\t\tto the security group with the ID sg-9a8d7f5c on TCP port 1433.[EC2-Classic, default VPC] The name of the security group.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n " + }, + "SourceSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "SourceSecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " + }, + "IpPermissions": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n " + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "Groups" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "flattened": true + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n " + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "flattened": true + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n " + }, + "documentation": "\n \n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nAdds one or more ingress rules to a security group.
\n\t\t\tEC2-Classic: You can have up to 100 rules per group.
\n\t\t\t\tEC2-VPC: You can have up to 50 rules per group (covering both ingress and\n\t\t\t\t\tegress rules).
\n\t\t\tRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n[EC2-Classic] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your account, or gives one or more security groups\n\t\t\t\t(called the source groups) permission to access a security\n\t\t\t\tgroup for your account. A source group can be for your own AWS account, or another.
\n[EC2-VPC] This action gives one or more CIDR IP address ranges permission to\n\t\t\t\taccess a security group in your VPC, or gives one or more other security groups\n\t\t\t\t(called the source groups) permission to access a security\n\t\t\t\tgroup for your VPC. The security groups must all be for the same VPC.
\n192.0.2.0/24\n\t\t\t\t\tand 198.51.100.0/24 address ranges to the security group for EC2-Classic \n\t\t\t\t\tnamed websrv.OtherAccountGroup (in AWS\n\t\t\t\t\taccount 123456789012) to the security group for EC2-Classic named websrv.OtherGroupInMyVPC\n\t\t\t\t\t(with the ID sg-2a2b3c4d) to the security group named VpcWebServers \n\t\t\t\t\t(with the ID sg-1a2b3c4d). In EC2-VPC, you must use the security group IDs in \n\t\t\t\t\ta request, not the security group names. In this example, your AWS account ID is 123456789012.default.default.The ID of the instance to bundle.
\n ", + "required": true + }, + "Storage": { + "shape_name": "Storage", + "type": "structure", + "members": { + "S3": { + "shape_name": "S3Storage", + "type": "structure", + "members": { + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
\n " + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe beginning of the file name of the AMI.
\n " + }, + "AWSAccessKeyId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.
\n " + }, + "UploadPolicy": { + "shape_name": "String", + "type": "blob", + "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n " + }, + "UploadPolicySignature": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe signature of the Base64 encoded JSON document.
\n " + } + }, + "documentation": "\nAn Amazon S3 storage location.
\n " + } + }, + "documentation": " \nThe bucket in which to store the AMI. You can specify a bucket that\n\t\t\t\tyou already own or a new bucket that Amazon EC2 creates on your behalf.\n\t\t\t\tIf you specify a bucket that belongs to someone else, Amazon EC2 returns\n\t\t\t\tan error.
\n ", + "required": true + } + }, + "documentation": " \n " + }, + "output": { + "shape_name": "BundleInstanceResult", + "type": "structure", + "members": { + "BundleTask": { + "shape_name": "BundleTask", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID of the instance associated with this bundle task.
\n ", + "xmlname": "instanceId" + }, + "BundleId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID for this bundle task.
\n ", + "xmlname": "bundleId" + }, + "State": { + "shape_name": "BundleTaskState", + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \nThe state of the task.
\n ", + "xmlname": "state" + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time this task started.
\n ", + "xmlname": "startTime" + }, + "UpdateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time of the most recent update for the task.
\n ", + "xmlname": "updateTime" + }, + "Storage": { + "shape_name": "Storage", + "type": "structure", + "members": { + "S3": { + "shape_name": "S3Storage", + "type": "structure", + "members": { + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
\n ", + "xmlname": "bucket" + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe beginning of the file name of the AMI.
\n ", + "xmlname": "prefix" + }, + "AWSAccessKeyId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.
\n " + }, + "UploadPolicy": { + "shape_name": "String", + "type": "string", + "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", + "xmlname": "uploadPolicy" + }, + "UploadPolicySignature": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", + "xmlname": "uploadPolicySignature" + } + }, + "documentation": "\nAn Amazon S3 storage location.
\n " + } + }, + "documentation": " \nThe Amazon S3 storage locations.
\n ", + "xmlname": "storage" + }, + "Progress": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", + "xmlname": "progress" + }, + "BundleTaskError": { + "shape_name": "BundleTaskError", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error code.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error message.
\n ", + "xmlname": "message" + } + }, + "documentation": " \nIf the task fails, a description of the error.
\n ", + "xmlname": "error" + } + }, + "documentation": " \nInformation about the bundle task.
\n ", + "xmlname": "bundleInstanceTask" + } + }, + "documentation": " \n " + }, + "errors": [], + "documentation": " \nBundles an Amazon instance store-backed Windows instance.
\nDuring bundling, only the root device volume (C:\\) is bundled. Data on other\n\t\t\t\tinstance store volumes is not preserved.
\nThis procedure is not applicable for Linux/Unix instances or Windows instances\n that are backed by Amazon EBS.
\n\t\t\tFor more information, see Creating an Instance Store-Backed Windows AMI.
\nThis example request bundles the specified instance.
\nBefore you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.
\nThe ID of the bundle task.
\n ", + "required": true + } + }, + "documentation": " \n " + }, + "output": { + "shape_name": "CancelBundleTaskResult", + "type": "structure", + "members": { + "BundleTask": { + "shape_name": "BundleTask", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID of the instance associated with this bundle task.
\n ", + "xmlname": "instanceId" + }, + "BundleId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID for this bundle task.
\n ", + "xmlname": "bundleId" + }, + "State": { + "shape_name": "BundleTaskState", + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \nThe state of the task.
\n ", + "xmlname": "state" + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time this task started.
\n ", + "xmlname": "startTime" + }, + "UpdateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time of the most recent update for the task.
\n ", + "xmlname": "updateTime" + }, + "Storage": { + "shape_name": "Storage", + "type": "structure", + "members": { + "S3": { + "shape_name": "S3Storage", + "type": "structure", + "members": { + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
\n ", + "xmlname": "bucket" + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe beginning of the file name of the AMI.
\n ", + "xmlname": "prefix" + }, + "AWSAccessKeyId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.
\n " + }, + "UploadPolicy": { + "shape_name": "String", + "type": "string", + "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", + "xmlname": "uploadPolicy" + }, + "UploadPolicySignature": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", + "xmlname": "uploadPolicySignature" + } + }, + "documentation": "\nAn Amazon S3 storage location.
\n " + } + }, + "documentation": " \nThe Amazon S3 storage locations.
\n ", + "xmlname": "storage" + }, + "Progress": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", + "xmlname": "progress" + }, + "BundleTaskError": { + "shape_name": "BundleTaskError", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error code.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error message.
\n ", + "xmlname": "message" + } + }, + "documentation": " \nIf the task fails, a description of the error.
\n ", + "xmlname": "error" + } + }, + "documentation": " \nThe bundle task.
\n ", + "xmlname": "bundleInstanceTask" + } + }, + "documentation": " \n " + }, + "errors": [], + "documentation": " \nCancels a bundling operation for an instance store-backed Windows instance.
\nThe ID of the conversion task.
\n ", + "required": true + }, + "ReasonMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nCancels an active conversion task. The task can be the import of an instance or volume. The\n action removes all artifacts of the conversion, including a partially uploaded volume or\n instance. If the conversion is complete or is in the process of transferring the final disk\n image, the command fails and returns an exception.
\n \nFor more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon\n EC2 in the Amazon Elastic Compute Cloud User Guide.
\nimport-i-fh95npoc.The ID of the export task. This is the ID\n returned by CreateInstanceExportTask.
Cancels an active export task. The request removes all artifacts of the export,\n including any partially-created Amazon S3 objects. If the export task is complete or\n is in the process of transferring the final disk image, the command fails and\n returns an error.
\nexport-i-1234wxyz.The ID of the Reserved Instance listing.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CancelReservedInstancesListingResult", + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape_name": "ReservedInstancesListingList", + "type": "list", + "members": { + "shape_name": "ReservedInstancesListing", + "type": "structure", + "members": { + "ReservedInstancesListingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance listing.
\n ", + "xmlname": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance.
\n ", + "xmlname": "reservedInstancesId" + }, + "CreateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the listing was created.
\n ", + "xmlname": "createDate" + }, + "UpdateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe last modified timestamp of the listing.
\n ", + "xmlname": "updateDate" + }, + "Status": { + "shape_name": "ListingStatus", + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\nThe status of the Reserved Instance listing.
\n ", + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\n ", + "xmlname": "statusMessage" + }, + "InstanceCounts": { + "shape_name": "InstanceCountList", + "type": "list", + "members": { + "shape_name": "InstanceCount", + "type": "structure", + "members": { + "State": { + "shape_name": "ListingState", + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\nThe states of the listed Reserved Instances.
\n ", + "xmlname": "state" + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe number of instances in this state.
\n ", + "xmlname": "instanceCounts" + }, + "PriceSchedules": { + "shape_name": "PriceScheduleList", + "type": "list", + "members": { + "shape_name": "PriceSchedule", + "type": "structure", + "members": { + "Term": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.
\n ", + "xmlname": "term" + }, + "Price": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price for the term.
\n ", + "xmlname": "price" + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.
\n ", + "xmlname": "active" + } + }, + "documentation": "\nDescribes the price for a Reserved Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe price of the Reserved Instance listing.
\n ", + "xmlname": "priceSchedules" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", + "xmlname": "clientToken" + } + }, + "documentation": "\nDescribes a Reserved Instance listing.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe Reserved Instance listing.
\n ", + "xmlname": "reservedInstancesListingsSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
\nFor more information, see \n Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.
\nOne or more Spot Instance request IDs.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CancelSpotInstanceRequestsResult", + "type": "structure", + "members": { + "CancelledSpotInstanceRequests": { + "shape_name": "CancelledSpotInstanceRequestList", + "type": "list", + "members": { + "shape_name": "CancelledSpotInstanceRequest", + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestId" + }, + "State": { + "shape_name": "CancelSpotInstanceRequestState", + "type": "string", + "enum": [ + "active", + "open", + "closed", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the Spot Instance request.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nDescribes a request to cancel a Spot Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more Spot Instance requests.
\n ", + "xmlname": "spotInstanceRequestSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCancels one or more Spot Instance requests. Spot Instances are instances that\n\t\t\t\tAmazon EC2 starts on your behalf when the maximum price that you specify exceeds the\n\t\t\t\tcurrent Spot Price. Amazon EC2 periodically sets the Spot Price based on available\n\t\t\t\tSpot Instance capacity and current Spot Instance requests. For more information\n\t\t\t\tabout Spot Instances, see Spot\n\t\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nCanceling a Spot Instance request does not terminate running Spot Instances\n\t\t\t\t\tassociated with the request.
\nThe product code. This must be an Amazon DevPay product code that you own.
\n ", + "required": true + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ConfirmProductInstanceResult", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the instance owner. This is only present if the product code\n\t\t\t\tis attached to the instance.
\n ", + "xmlname": "ownerId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDetermines whether a product code is associated with an instance. This action can\n\t\t\t\tonly be used by the owner of the product code. It is useful when a product code\n\t\t\t\towner needs to verify whether another user's instance is eligible for\n\t\t\t\tsupport.
\nThe name of the region that contains the AMI to copy.
\n ", + "required": true + }, + "SourceImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI to copy.
\n ", + "required": true + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the new AMI in the destination region.
\n ", + "required": false + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": " \nA description for the new AMI in the destination region.
\n " + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": " \nUnique, case-sensitive identifier you provide to ensure\n\t\t\t\tidempotency of the request. For more information, see How to Ensure Idempotency in the \n\t\t\t Amazon Elastic Compute Cloud User Guide.
\n " + } + }, + "documentation": " \n " + }, + "output": { + "shape_name": "CopyImageResult", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID of the new AMI.
\n ", + "xmlname": "imageId" + } + }, + "documentation": " \n " + }, + "errors": [], + "documentation": " \nInitiates the copy of an AMI from the specified source region to the region in which the\n request was made. You specify the destination region by using its endpoint when making the\n request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.
\nFor more information, see Copying AMIs\n in the Amazon Elastic Compute Cloud User Guide.
\nus-west-2 with the ID ami-1a2b3c4d,\n\t\t\t\t\tnaming the new AMI My-Standard-AMI.The ID of the region that contains the snapshot to be copied.
\n ", + "required": true + }, + "SourceSnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Amazon EBS snapshot to copy.
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for the new Amazon EBS snapshot.
\n " + }, + "DestinationRegion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe destination region of the snapshot copy operation. This parameter is required in the\n PresignedUrl.
The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only\n required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an\n optional parameter in all other cases. The PresignedUrl should use the snapshot\n source endpoint, the CopySnapshot action, and include the\n SourceRegion, SourceSnapshotId, and DestinationRegion\n parameters. The PresignedUrl must be signed using AWS Signature Version 4.\n Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the\n same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the\n Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause\n the copy operation to fail asynchronously, and the snapshot will move to an error\n state.
The ID of the new snapshot.
\n ", + "xmlname": "snapshotId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCopies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the\n snapshot within the same region or from one region to another. You can use the snapshot to\n create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional\n endpoint that you send the HTTP request to.
\nCopies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain\n unencrypted.
\nFor more information, see Copying an Amazon EBS Snapshot in the\n Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.The type of VPN connection that this customer gateway supports.
\n ", + "required": true + }, + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Internet-routable IP address for the customer gateway's outside\n\t\t\t\tinterface. The address must be static.
\n ", + "required": true, + "xmlname": "IpAddress" + }, + "BgpAsn": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tFor devices that support BGP, the customer gateway's BGP ASN.
\n\t\tDefault: 65000
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateCustomerGatewayResult", + "type": "structure", + "members": { + "CustomerGateway": { + "shape_name": "CustomerGateway", + "type": "structure", + "members": { + "CustomerGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the customer gateway.
\n ", + "xmlname": "customerGatewayId" + }, + "State": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe current state of the customer gateway.
\n ", + "xmlname": "state" + }, + "Type": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe type of VPN connection the customer gateway supports.
\n ", + "xmlname": "type" + }, + "IpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Internet-routable IP address of the customer gateway's outside interface.
\n ", + "xmlname": "ipAddress" + }, + "BgpAsn": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
\n ", + "xmlname": "bgpAsn" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the customer gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tInformation about the customer gateway.
\n ", + "xmlname": "customerGateway" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tProvides information to AWS about your VPN customer gateway device. The customer\n\t\t\t\tgateway is the appliance at your end of the VPN connection. (The device on the AWS\n\t\t\t\tside of the VPN connection is the virtual private gateway.) You must provide the\n\t\t\t\tInternet-routable IP address of the customer gateway's external interface. The IP\n\t\t\t\taddress must be static and can't be behind a device performing network address\n\t\t\t\ttranslation (NAT).
\n\t\tFor devices that use Border Gateway Protocol (BGP), you can also provide the\n\t\t\t\tdevice's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to\n\t\t\t\tyour network. If you don't have an ASN already, you can use a private ASN (in the\n\t\t\t\t64512 - 65534 range).
\n\t\t\tAmazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the\n\t\t\t\t\texception of 7224, which is reserved in the us-east-1 region, and 9059, which is\n\t\t\t\t\treserved in the eu-west-1 region.
For more information about VPN customer gateways, see\n\t\t\t\t\tAdding a Hardware\n\t\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n12.1.2.3 and BGP ASN 65534.The name of a DHCP option.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", + "flattened": true + } + }, + "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", + "xmlname": "DhcpConfiguration" + }, + "documentation": "\n\t\tA DHCP configuration option.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateDhcpOptionsResult", + "type": "structure", + "members": { + "DhcpOptions": { + "shape_name": "DhcpOptions", + "type": "structure", + "members": { + "DhcpOptionsId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the set of DHCP options.
\n ", + "xmlname": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "shape_name": "DhcpConfigurationList", + "type": "list", + "members": { + "shape_name": "DhcpConfiguration", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe name of a DHCP option.
\n ", + "xmlname": "key" + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", + "xmlname": "valueSet" + } + }, + "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more DHCP options in the set.
\n ", + "xmlname": "dhcpConfigurationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the DHCP options set.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tA set of DHCP options.
\n ", + "xmlname": "dhcpOptions" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a set of DHCP options for your VPC. After creating the set, you must\n\t\t\t\tassociate it with the VPC, causing all existing and new instances that you launch in\n\t\t\t\tthe VPC to use this set of DHCP options. The following are the individual DHCP\n\t\t\t\toptions you can specify. For more information about the options, see RFC 2132.
\ndomain-name-servers - The IP addresses of up to four domain name servers, or\n AmazonProvidedDNS. The default DHCP option set specifies\n AmazonProvidedDNS. If specifying more than one domain name server, specify\n the IP addresses in a single parameter, separated by commas.domain-name - If you're using AmazonProvidedDNS in us-east-1,\n\t\t\t\tspecify ec2.internal. If you're using AmazonProvidedDNS in another region,\n\t\t\t\tspecify region.compute.internal (for example,\n\t\t\t\t\tap-northeast-1.compute.internal). Otherwise, specify a domain name (for\n\t\t\t\texample, MyCompany.com). If specifying more than one domain name, separate them\n\t\t\t\twith spaces.ntp-servers - The IP addresses of up to four Network Time Protocol (NTP)\n servers.netbios-name-servers - The IP addresses of up to four NetBIOS name\n servers.netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that\n you specify 2 (broadcast and multicast are not currently supported). For more information\n about these node types, see RFC 2132. For more information about DHCP options, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\nexample.com and two DNS servers (10.2.5.1 and\n 10.2.5.2). The DNS servers' IP addresses are specified in a single\n parameter, separated by commas, to preserve the order in which they are\n specified.The ID of the instance.
\n ", + "required": true + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nA name for the new image.
\nConstraints: 3-128 alphanumeric characters, parenthesis (()), periods (.), slashes\n\t\t\t\t(/), dashes (-), or underscores(_)
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for the new image.
\n " + }, + "NoReboot": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nBy default, this parameter is set to false, which means\n\t\t\t\tAmazon EC2 attempts to shut down the instance cleanly before image\n\t\t\t\tcreation and then reboots the instance. When the parameter is set to\n\t\t\t\ttrue, Amazon EC2 doesn't shut down the instance before\n\t\t\t\tcreating the image. When this option is used, file system integrity on\n\t\t\t\tthe created image can't be guaranteed.
The virtual device name.
\n " + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n " + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "BlockDeviceMapping" + }, + "documentation": "\nInformation about one or more block device mappings.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateImageResult", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the new AMI.
\n ", + "xmlname": "imageId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nCreates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either\n\t\t\t\trunning or stopped.
\nIf you customized your instance with instance store volumes or EBS volumes\n\t\t\t\tin addition to the root device volume, the new AMI contains block device mapping\n\t\t\t\tinformation for those volumes. When you launch an instance from this new AMI,\n\t\t\t\tthe instance automatically launches with those additional volumes.
\nFor more information, see Creating Amazon EBS-Backed Linux AMIs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nA description for the conversion task or the resource being\n exported. The maximum length is 255 bytes.
\n " + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "required": true + }, + "TargetEnvironment": { + "shape_name": "ExportEnvironment", + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\nThe target virtualization environment.
\n " + }, + "ExportToS3Task": { + "shape_name": "ExportToS3TaskSpecification", + "type": "structure", + "members": { + "DiskImageFormat": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\n " + }, + "ContainerFormat": { + "shape_name": "ContainerFormat", + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\n " + }, + "S3Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\n " + }, + "S3Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe image is written to a single object in the Amazon S3 bucket at the S3 key\n s3prefix + exportTaskId + '.' + diskImageFormat.
\n " + } + }, + "documentation": "\n ", + "xmlname": "ExportToS3" + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateInstanceExportTaskResult", + "type": "structure", + "members": { + "ExportTask": { + "shape_name": "ExportTask", + "type": "structure", + "members": { + "ExportTaskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the export task.
\n ", + "xmlname": "exportTaskId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the resource being exported.
\n ", + "xmlname": "description" + }, + "State": { + "shape_name": "ExportTaskState", + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the conversion task.
\n ", + "xmlname": "state" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status message related to the export task.
\n ", + "xmlname": "statusMessage" + }, + "InstanceExportDetails": { + "shape_name": "InstanceExportDetails", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the resource being exported.
\n ", + "xmlname": "instanceId" + }, + "TargetEnvironment": { + "shape_name": "ExportEnvironment", + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\nThe target virtualization environment.
\n ", + "xmlname": "targetEnvironment" + } + }, + "documentation": "\nThe instance being exported.
\n ", + "xmlname": "instanceExport" + }, + "ExportToS3Task": { + "shape_name": "ExportToS3Task", + "type": "structure", + "members": { + "DiskImageFormat": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe format for the exported image.
\n ", + "xmlname": "diskImageFormat" + }, + "ContainerFormat": { + "shape_name": "ContainerFormat", + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\nThe container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.
\n ", + "xmlname": "containerFormat" + }, + "S3Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n vm-import-export@amazon.com.
Exports a running or stopped instance to an Amazon S3 bucket.
\n \nFor information about the supported operating systems, image formats, and known limitations for the\n types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the Internet gateway.
\n ", + "xmlname": "internetGatewayId" + }, + "Attachments": { + "shape_name": "InternetGatewayAttachmentList", + "type": "list", + "members": { + "shape_name": "InternetGatewayAttachment", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe current state of the attachment.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes the attachment of a VPC to an Internet gateway.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny VPCs attached to the Internet gateway.
\n ", + "xmlname": "attachmentSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the Internet gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tInformation about the Internet gateway.
\n ", + "xmlname": "internetGateway" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates an Internet gateway for use with a VPC. After creating the Internet\n\t\t\t\tgateway, you attach it to a VPC using AttachInternetGateway.
\n\t\tFor more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.
\nA unique name for the key pair.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateKeyPairResult", + "type": "structure", + "members": { + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair.
\n ", + "xmlname": "keyName" + }, + "KeyFingerprint": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe SHA-1 digest of the DER encoded private key.
\n ", + "xmlname": "keyFingerprint" + }, + "KeyMaterial": { + "shape_name": "String", + "type": "string", + "documentation": "\nAn unencrypted PEM encoded RSA private key.
\n ", + "xmlname": "keyMaterial" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key\n\t\t\t\tand displays the private key for you to save to a file. The private key is\n\t\t\t\treturned as an unencrypted PEM encoded PKCS#8 private key. If a key with the\n\t\t\t\tspecified name already exists, Amazon EC2 returns an error.
\nYou can have up to five thousand key pairs per region.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nmy-key-pair.The ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateNetworkAclResult", + "type": "structure", + "members": { + "NetworkAcl": { + "shape_name": "NetworkAcl", + "type": "structure", + "members": { + "NetworkAclId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network ACL.
\n ", + "xmlname": "networkAclId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC for the network ACL.
\n ", + "xmlname": "vpcId" + }, + "IsDefault": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the default network ACL for the VPC.
\n ", + "xmlname": "default" + }, + "Entries": { + "shape_name": "NetworkAclEntryList", + "type": "list", + "members": { + "shape_name": "NetworkAclEntry", + "type": "structure", + "members": { + "RuleNumber": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe rule number for the entry. ACL entries are processed in ascending order by rule number.
\n ", + "xmlname": "ruleNumber" + }, + "Protocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", + "xmlname": "ruleAction" + }, + "Egress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the rule is an egress rule (applied to traffic leaving the subnet).
\n ", + "xmlname": "egress" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", + "xmlname": "cidrBlock" + }, + "IcmpTypeCode": { + "shape_name": "IcmpTypeCode", + "type": "structure", + "members": { + "Type": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n ", + "xmlname": "type" + }, + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n ", + "xmlname": "code" + } + }, + "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", + "xmlname": "icmpTypeCode" + }, + "PortRange": { + "shape_name": "PortRange", + "type": "structure", + "members": { + "From": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe first port in the range.
\n ", + "xmlname": "from" + }, + "To": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe last port in the range.
\n ", + "xmlname": "to" + } + }, + "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n ", + "xmlname": "portRange" + } + }, + "documentation": "\n\t\tDescribes an entry in a network ACL.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more entries (rules) in the network ACL.
\n ", + "xmlname": "entrySet" + }, + "Associations": { + "shape_name": "NetworkAclAssociationList", + "type": "list", + "members": { + "shape_name": "NetworkAclAssociation", + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the association between a network ACL and a subnet.
\n ", + "xmlname": "networkAclAssociationId" + }, + "NetworkAclId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network ACL.
\n ", + "xmlname": "networkAclId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + } + }, + "documentation": "\n\t\tDescribes an association between a network ACL and a subnet.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny associations between the network ACL and one or more subnets
\n ", + "xmlname": "associationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the network ACL.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tInformation about the network ACL.
\n ", + "xmlname": "networkAcl" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition\n\t\t\t\tto security groups) for the instances in your VPC.
\n\t\tFor more information about network ACLs, see Network ACLs in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nThe ID of the ACL.
\n ", + "required": true + }, + "RuleNumber": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe rule number for the entry (for example, 100). ACL\n\t\t\t\tentries are processed in ascending order by rule number.
\nConstraints: Positive integer from 1 to 32766
\n ", + "required": true + }, + "Protocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
\n ", + "required": true + }, + "RuleAction": { + "shape_name": "RuleAction", + "type": "string", + "enum": [ + "allow", + "deny" + ], + "documentation": "\n\t\tIndicates whether to allow or deny the traffic that matches the rule.
\n ", + "required": true + }, + "Egress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
\n ", + "required": true + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", + "required": true + }, + "IcmpTypeCode": { + "shape_name": "IcmpTypeCode", + "type": "structure", + "members": { + "Type": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n " + }, + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n " + } + }, + "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", + "xmlname": "Icmp" + }, + "PortRange": { + "shape_name": "PortRange", + "type": "structure", + "members": { + "From": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe first port in the range.
\n " + }, + "To": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe last port in the range.
\n " + } + }, + "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tCreates an entry (a rule) in a network ACL with the specified rule number. Each\n\t\t\t\tnetwork ACL has a set of numbered ingress rules and a separate set of numbered\n\t\t\t\tegress rules. When determining whether a packet should be allowed in or out of a\n\t\t\t\tsubnet associated with the ACL, we process the entries in the ACL according to the\n\t\t\t\trule numbers, in ascending order. Each network ACL has a set of ingress rules and a\n\t\t\t\tseparate set of egress rules.
\n\t\tWe recommend that you leave room between the rule numbers (for example,\n\t\t\t\t100, 110, 120, ...), and not number them one right after the other (for\n\t\t\t\texample, 101, 102, 103, ...). This makes it easier to add a rule between\n\t\t\t\texisting ones without having to renumber the rules.
\n\t\tAfter you add an entry, you can't modify it; you must either replace it, or create\n\t\t\t\tan entry and delete the old one.
\n\t\tFor more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
\nacl-2cb85d45. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP\n\t\t\t\t\tport 53 into any associated subnet.The ID of the subnet to associate with the network interface.
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tA description for the network interface.
\n " + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe primary private IP address of the network interface. If you don't specify an IP\n\t\t\t\taddress, Amazon EC2 selects one for you from the subnet range.
\n " + }, + "Groups": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\n\t\tThe IDs of one or more security groups.
\n ", + "flattened": true + }, + "PrivateIpAddresses": { + "shape_name": "PrivateIpAddressSpecificationList", + "type": "list", + "members": { + "shape_name": "PrivateIpAddressSpecification", + "type": "structure", + "members": { + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP addresses.
\n ", + "required": true + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " + } + }, + "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n " + }, + "documentation": "\n\t\tOne or more private IP addresses.
\n ", + "flattened": true + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of secondary private IP addresses to assign to a network\n\t\t\t\tinterface. When you specify a number of secondary IP addresses, Amazon EC2\n\t\t\t\tselects these IP addresses within the subnet range.
\nThe number of IP addresses you can assign to a network interface\n\t\t\t\tvaries by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\n " + }, + "DryRun": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateNetworkInterfaceResult", + "type": "structure", + "members": { + "NetworkInterface": { + "shape_name": "NetworkInterface", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone.
\n ", + "xmlname": "availabilityZone" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tA description.
\n ", + "xmlname": "description" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the network interface.
\n ", + "xmlname": "ownerId" + }, + "RequesterId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).
\n ", + "xmlname": "requesterId" + }, + "RequesterManaged": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is being managed by AWS.
\n ", + "xmlname": "requesterManaged" + }, + "Status": { + "shape_name": "NetworkInterfaceStatus", + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\tThe status of the network interface.
\n ", + "xmlname": "status" + }, + "MacAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe MAC address.
\n ", + "xmlname": "macAddress" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether traffic to or from the instance is validated.
\n ", + "xmlname": "sourceDestCheck" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny security groups for the network interface.
\n ", + "xmlname": "groupSet" + }, + "Attachment": { + "shape_name": "NetworkInterfaceAttachment", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "InstanceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", + "xmlname": "instanceOwnerId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", + "xmlname": "deviceIndex" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n\t\tThe network interface attachment.
\n ", + "xmlname": "attachment" + }, + "Association": { + "shape_name": "NetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n\t", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", + "xmlname": "ipOwnerId" + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe allocation ID.
\n ", + "xmlname": "allocationId" + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe association ID.
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", + "xmlname": "association" + }, + "TagSet": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the network interface.
\n ", + "xmlname": "tagSet" + }, + "PrivateIpAddresses": { + "shape_name": "NetworkInterfacePrivateIpAddressList", + "type": "list", + "members": { + "shape_name": "NetworkInterfacePrivateIpAddress", + "type": "structure", + "members": { + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address of the network interface.
\n ", + "xmlname": "primary" + }, + "Association": { + "shape_name": "NetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n\t", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", + "xmlname": "ipOwnerId" + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe allocation ID.
\n ", + "xmlname": "allocationId" + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe association ID.
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP address associated with the network interface.
\n ", + "xmlname": "association" + } + }, + "documentation": "\n\t\tDescribes the private IP address of a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + } + }, + "documentation": "\n\t\tInformation about the network interface.
\n ", + "xmlname": "networkInterface" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a network interface in the specified subnet.
\n\t\tFor more information about network interfaces, see Elastic Network Interfaces \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n10.0.2.140 and four secondary private IP\n\t\t\t\t\taddresses that are automatically selected by Amazon EC2.A name for the placement group.
\nConstraints: Up to 255 ASCII characters
\n ", + "required": true + }, + "Strategy": { + "shape_name": "PlacementStrategy", + "type": "string", + "enum": [ + "cluster" + ], + "documentation": "\nThe placement strategy.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nCreates a placement group that you launch cluster instances into. You must give\n\t\t\t the group a name that's unique within the scope of your account.
\nFor more information about placement groups and cluster instances, see\n\t\t\t\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nXYZ-cluster.The ID of the active Reserved Instance.
\n ", + "required": true + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of instances that are a part of a Reserved Instance account to be listed\n\t\t\t\tin the Reserved Instance Marketplace. This number should be less than or equal to the\n\t\t\t\tinstance count associated with the Reserved Instance ID specified in this call.
\n ", + "required": true + }, + "PriceSchedules": { + "shape_name": "PriceScheduleSpecificationList", + "type": "list", + "members": { + "shape_name": "PriceScheduleSpecification", + "type": "structure", + "members": { + "Term": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.
\n " + }, + "Price": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price for the term.
\n " + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
Describes the price for a Reserved Instance.
\n " + }, + "documentation": "\nA list specifying the price of the Reserved Instance for each month\n\t\t\t\tremaining in the Reserved Instance term.
\n ", + "required": true, + "flattened": true + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nUnique, case-sensitive identifier you provide to ensure idempotency of your\n\t\t\t\tlistings. This helps avoid duplicate listings. For more information, see \n\t\t\t\tEnsuring Idempotency \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateReservedInstancesListingResult", + "type": "structure", + "members": { + "ReservedInstancesListings": { + "shape_name": "ReservedInstancesListingList", + "type": "list", + "members": { + "shape_name": "ReservedInstancesListing", + "type": "structure", + "members": { + "ReservedInstancesListingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance listing.
\n ", + "xmlname": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance.
\n ", + "xmlname": "reservedInstancesId" + }, + "CreateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the listing was created.
\n ", + "xmlname": "createDate" + }, + "UpdateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe last modified timestamp of the listing.
\n ", + "xmlname": "updateDate" + }, + "Status": { + "shape_name": "ListingStatus", + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\nThe status of the Reserved Instance listing.
\n ", + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\n ", + "xmlname": "statusMessage" + }, + "InstanceCounts": { + "shape_name": "InstanceCountList", + "type": "list", + "members": { + "shape_name": "InstanceCount", + "type": "structure", + "members": { + "State": { + "shape_name": "ListingState", + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\nThe states of the listed Reserved Instances.
\n ", + "xmlname": "state" + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe number of instances in this state.
\n ", + "xmlname": "instanceCounts" + }, + "PriceSchedules": { + "shape_name": "PriceScheduleList", + "type": "list", + "members": { + "shape_name": "PriceSchedule", + "type": "structure", + "members": { + "Term": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.
\n ", + "xmlname": "term" + }, + "Price": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price for the term.
\n ", + "xmlname": "price" + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.
\n ", + "xmlname": "active" + } + }, + "documentation": "\nDescribes the price for a Reserved Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe price of the Reserved Instance listing.
\n ", + "xmlname": "priceSchedules" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", + "xmlname": "clientToken" + } + }, + "documentation": "\nDescribes a Reserved Instance listing.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about the Reserved Instances listing.
\n ", + "xmlname": "reservedInstancesListingsSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. \n You can submit one Reserved Instance listing at a time.
\nFor more information, see Reserved Instance Marketplace in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nThe ID of the route table for the route.
\n ", + "required": true + }, + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR address block used for the destination match. Routing\n\t\t\t\tdecisions are based on the most specific match.
\n ", + "required": true + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of an Internet gateway attached to your VPC.
\n " + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a NAT instance in your VPC. The operation fails if\n\t\t\t\tyou specify an instance ID unless exactly one network interface is\n\t\t\t\tattached.
\n " + }, + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a network interface.
\n " + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of a VPC peering connection.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nCreates a route in a route table within a VPC.
\nYou must specify one of the following targets: Internet gateway, NAT instance, VPC peering connection, or network interface.
\nWhen determining how to route traffic, we use the route with the most specific\n\t\t\tmatch. For example, let's say the traffic is destined for 192.0.2.3, and the route\n\t\t\ttable includes the following two routes:
192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3. However, the second route\n\t\t\t\tin the list covers a smaller number of IP addresses and is therefore more specific,\n\t\t\t\tso we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nrtb-e4ad488d. The\n\t\t\t\t\troute matches all traffic (0.0.0.0/0) and routes it to the Internet gateway with the\n\t\t\t\t\tID igw-eaad4883.rtb-g8ff4ea2. The\n\t\t\t\t\troute sends all traffic (0.0.0.0/0) to the NAT instance with the ID\n\t\t\t\t\ti-1a2b3c4d.rtb-g8ff4ea2. The route\n matches traffic for the CIDR block 10.0.0.0/16 and routes it to VPC\n peering connection, pcx-111aaa22. This route enables traffic to be\n directed to the other peered VPC in the VPC peering connection.The ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateRouteTableResult", + "type": "structure", + "members": { + "RouteTable": { + "shape_name": "RouteTable", + "type": "structure", + "members": { + "RouteTableId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the route table.
\n ", + "xmlname": "routeTableId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "Routes": { + "shape_name": "RouteList", + "type": "list", + "members": { + "shape_name": "Route", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block used for the destination match.
\n ", + "xmlname": "destinationCidrBlock" + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a gateway attached to your VPC.
\n ", + "xmlname": "gatewayId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n ", + "xmlname": "instanceId" + }, + "InstanceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", + "xmlname": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnectionId" + }, + "State": { + "shape_name": "RouteState", + "type": "string", + "enum": [ + "active", + "blackhole" + ], + "documentation": "\n\t\tThe state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).
Describes how the route was created.
\nCreateRouteTable indicates that route was automatically created when the route table was created.CreateRoute indicates that the route was manually added to the route table.EnableVgwRoutePropagation indicates that the route was propagated by route propagation.Describes a route in a route table.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe routes in the route table.
\n ", + "xmlname": "routeSet" + }, + "Associations": { + "shape_name": "RouteTableAssociationList", + "type": "list", + "members": { + "shape_name": "RouteTableAssociation", + "type": "structure", + "members": { + "RouteTableAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the association between a route table and a subnet.
\n ", + "xmlname": "routeTableAssociationId" + }, + "RouteTableId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the route table.
\n ", + "xmlname": "routeTableId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "Main": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the main route table.
\n ", + "xmlname": "main" + } + }, + "documentation": "\n\t\tDescribes an association between a route table and a subnet.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe associations between the route table and one or more subnets.
\n ", + "xmlname": "associationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the route table.
\n ", + "xmlname": "tagSet" + }, + "PropagatingVgws": { + "shape_name": "PropagatingVgwList", + "type": "list", + "members": { + "shape_name": "PropagatingVgw", + "type": "structure", + "members": { + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway (VGW).
\n ", + "xmlname": "gatewayId" + } + }, + "documentation": "\n\t\tDescribes a virtual private gateway propagating route.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny virtual private gateway (VGW) propagating routes.
\n ", + "xmlname": "propagatingVgwSet" + } + }, + "documentation": "\n\t\tInformation about the route table.
\n ", + "xmlname": "routeTable" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a route table for the specified VPC. After you create a route table, you can\n\t\t\tadd routes and associate the table with a subnet.
\nFor more information about route tables, see Route Tables in\n\t\t\t\tthe Amazon Virtual Private Cloud User Guide.
\nvpc-11ad4878.\n By default, every route table includes a local route that enables traffic to\n\t\t\t\t\tflow within the VPC. The following response shows that route.The name of the security group.
\nConstraints: Up to 255 characters in length
\nConstraints for EC2-Classic: ASCII characters
\nConstraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for the security group. This is informational only.
\n ", + "required": true, + "xmlname": "GroupDescription" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The ID of the VPC.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateSecurityGroupResult", + "type": "structure", + "members": { + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a security group.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nEC2-Classic: You can have up to 500 security groups.
\n\t\t\t\tEC2-VPC: You can create up to 100 security groups per VPC.
\n\t\t\tWhen you create a security group, you specify a friendly name of your choice. You\n\t\t\t\tcan have a security group for use in EC2-Classic with the same name as a security group\n\t\t\t\tfor use in a VPC. However, you can't have two security groups for use in EC2-Classic with the\n\t\t\t\tsame name or two security groups for use in a VPC with the same name.
\nYou have a default security group for use in EC2-Classic and a default security group\n\t\t\t\tfor use in your VPC. If you don't specify a security group when you launch an instance, the\n\t\t\t\tinstance is launched into the appropriate default security group. A default security\n\t\t\t\tgroup includes a default rule that grants instances unrestricted network access to\n\t\t\t\teach other.
\nYou can add or remove rules from your security groups using \n\t\t\t\t\tAuthorizeSecurityGroupIngress,\n\t\t\t\t\tAuthorizeSecurityGroupEgress,\n\t\t\t\t\tRevokeSecurityGroupIngress, and\n\t\t\t\t\tRevokeSecurityGroupEgress.
\nwebsrv for EC2-Classic.WebServerSG for the specified VPC.The ID of the Amazon EBS volume.
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for the snapshot.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "Snapshot", + "type": "structure", + "members": { + "SnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "State": { + "shape_name": "SnapshotState", + "type": "string", + "enum": [ + "pending", + "completed", + "error" + ], + "documentation": "\nThe snapshot state.
\n ", + "xmlname": "status" + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the snapshot was initiated.
\n ", + "xmlname": "startTime" + }, + "Progress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe progress of the snapshot, as a percentage.
\n ", + "xmlname": "progress" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EBS snapshot owner.
\n ", + "xmlname": "ownerId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for the snapshot.
\n ", + "xmlname": "description" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\n ", + "xmlname": "volumeSize" + }, + "OwnerAlias": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.
Indicates whether the snapshot is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\n ", + "xmlname": "snapshot" + }, + "errors": [], + "documentation": "\nCreates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups,\n to make copies of Amazon EBS volumes, and to save data before shutting down an instance.
\nWhen a snapshot is created, any AWS Marketplace product codes that are associated with the\n source volume are propagated to the snapshot.
\nYou can take a snapshot of an attached volume that is in use. However, snapshots only capture\n data that has been written to your Amazon EBS volume at the time the snapshot command is issued;\n this may exclude any data that has been cached by any applications or the operating system. If\n you can pause any file systems on the volume long enough to take a snapshot, your snapshot\n should be complete. However, if you cannot pause all file writes to the volume, you should\n unmount the volume from within the instance, issue the snapshot command, and then remount the\n volume to ensure a consistent and complete snapshot. You may remount and use your volume while\n the snapshot status is pending.
To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance\n before taking the snapshot.
\nSnapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are\n created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and\n any associated snapshots always remain protected.
\nFor more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The Amazon S3 bucket in which to store the Spot Instance datafeed.
\nConstraints: Must be a valid bucket associated with your AWS account.
\n ", + "required": true + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nA prefix for the datafeed file names.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateSpotDatafeedSubscriptionResult", + "type": "structure", + "members": { + "SpotDatafeedSubscription": { + "shape_name": "SpotDatafeedSubscription", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the account.
\n ", + "xmlname": "ownerId" + }, + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon S3 bucket where the Spot Instance datafeed is located.
\n ", + "xmlname": "bucket" + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe prefix that is prepended to datafeed files.
\n ", + "xmlname": "prefix" + }, + "State": { + "shape_name": "DatafeedSubscriptionState", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "documentation": "\nThe state of the Spot Instance datafeed subscription.
\n ", + "xmlname": "state" + }, + "Fault": { + "shape_name": "SpotInstanceStateFault", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the Spot Instance state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the Spot Instance state change.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", + "xmlname": "fault" + } + }, + "documentation": "\nThe Spot Instance datafeed subscription.
\n ", + "xmlname": "spotDatafeedSubscription" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs.\n\t\t\t\tYou can create one data feed per AWS account. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nThe ID of the VPC.
\n ", + "required": true + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
The Availability Zone for the subnet.
\n\t\tDefault: Amazon EC2 selects one for you (recommended).
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateSubnetResult", + "type": "structure", + "members": { + "Subnet": { + "shape_name": "Subnet", + "type": "structure", + "members": { + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "State": { + "shape_name": "SubnetState", + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\tThe current state of the subnet.
\n ", + "xmlname": "state" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC the subnet is in.
\n ", + "xmlname": "vpcId" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block assigned to the subnet.
\n ", + "xmlname": "cidrBlock" + }, + "AvailableIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.
\n ", + "xmlname": "availableIpAddressCount" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone of the subnet.
\n ", + "xmlname": "availabilityZone" + }, + "DefaultForAz": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the default subnet for the Availability Zone.
\n ", + "xmlname": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether instances launched in this subnet receive a public IP address.
\n ", + "xmlname": "mapPublicIpOnLaunch" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the subnet.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tInformation about the subnet.
\n ", + "xmlname": "subnet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a subnet in an existing VPC.
\nWhen you create each subnet, you provide the VPC ID and the CIDR block you want\n\t\t\t\tfor the subnet. After you create a subnet, you can't change its CIDR block. The\n\t\t\t\tsubnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only\n\t\t\t\ta single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more\n\t\t\t\tthan one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest\n\t\t\t\tsubnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the\n\t\t\t\tlargest uses a /16 netmask (65,536 IP addresses).
\nAWS reserves both the first four and the last IP address in each subnet's\n CIDR block. They're not available for use.
\nIf you add more than one subnet to a VPC, they're set up in a star topology with a\n\t\t\t\tlogical router in the middle.
\n\t\tFor more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\n10.0.1.0/24 in the VPC with the ID\n\t\t\t\t\tvpc-1a2b3c4d.The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
\n ", + "required": true, + "flattened": true + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n " + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "Tag" + }, + "documentation": "\nOne or more tags. The value parameter is required, but if you don't want the tag to have a value,\n specify the parameter with no value, and we set the value to an empty\n string.
Adds or overwrites one or more tags for the specified EC2 resource or resources.\n Each resource can have a maximum of 10 tags. Each tag consists of a key and optional\n value. Tag keys must be unique per resource.
\nFor more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.
\nwebserver), with no value (we set the value to an empty\n string). The other tag consists of a key (stack) and value\n (Production).The size of the volume, in GiBs.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the\n default is the snapshot size.
\n " + }, + "SnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe snapshot from which to create the volume.
\n " + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which to create the volume. Use DescribeAvailabilityZones to\n list the Availability Zones that are currently available to you.
\n ", + "required": true + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
Default: standard
Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to\n provision for the volume.
\n " + }, + "Encrypted": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether the volume should be encrypted.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "Volume", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "Size": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiBs.
\n ", + "xmlname": "size" + }, + "SnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe snapshot from which the volume was created, if applicable.
\n ", + "xmlname": "snapshotId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone for the volume.
\n ", + "xmlname": "availabilityZone" + }, + "State": { + "shape_name": "VolumeState", + "type": "string", + "enum": [ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ], + "documentation": "\nThe volume state.
\n ", + "xmlname": "status" + }, + "CreateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when volume creation was initiated.
\n ", + "xmlname": "createTime" + }, + "Attachments": { + "shape_name": "VolumeAttachmentList", + "type": "list", + "members": { + "shape_name": "VolumeAttachment", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name.
\n ", + "xmlname": "device" + }, + "State": { + "shape_name": "VolumeAttachmentState", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state of the volume.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\nDescribes volume attachment details.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "attachmentSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the volume.
\n ", + "xmlname": "tagSet" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD)\n volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD)\n volumes, this represents the baseline performance of the volume and the rate at which the\n volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline\n performance, I/O credits, and bursting, see Amazon EBS\n Volume Types in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\n ", + "xmlname": "volume" + }, + "errors": [], + "documentation": "\nCreates an Amazon EBS volume that can be attached to an instance in the same Availability Zone.\n The volume is created in the specified region.
\nYou can create a new empty volume or restore a volume from an Amazon EBS snapshot.\n Any AWS Marketplace product codes from the snapshot are propagated to the volume.
\nYou can create encrypted volumes with the\n Encrypted parameter. Encrypted volumes may only be attached to instances\n that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also\n automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating or\n Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
\nus-east-1a.The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
The supported tenancy options for instances launched into the VPC.\n\t\t\t\tA value of default means that instances can be launched\n\t\t\t\twith any tenancy; a value of dedicated means all instances\n\t\t\t\tlaunched into the VPC are launched as dedicated tenancy instances regardless of the tenancy\n\t\t\t\tassigned to the instance at launch. Dedicated tenancy instances\n\t\t\t\truns on single-tenant hardware.
Default: default
The ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "VpcState", + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\tThe current state of the VPC.
\n ", + "xmlname": "state" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "DhcpOptionsId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the VPC.
\n ", + "xmlname": "tagSet" + }, + "InstanceTenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n\t\tThe allowed tenancy of instances launched into the VPC.
\n ", + "xmlname": "instanceTenancy" + }, + "IsDefault": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the VPC is the default VPC.
\n ", + "xmlname": "isDefault" + } + }, + "documentation": "\n\t\tInformation about the VPC.
\n ", + "xmlname": "vpc" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a VPC with the specified CIDR block.
\n\t\tThe smallest VPC you can create uses a /28 netmask (16 IP addresses), \n\t\t\t\tand the largest uses a /16 netmask (65,536 IP addresses). \n\t\t\t\tTo help you decide how big to make your VPC, see Your VPC and Subnets in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n\t\tBy default, each instance you launch in the VPC has the default DHCP options, which\n\t\t\t includes only a default DNS server that we provide (AmazonProvidedDNS).\n\t\t\t For more information about DHCP options, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\n10.0.0.0/16.dedicated tenancy option.The ID of the requester VPC.
\n " + }, + "PeerVpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC with which you are creating the VPC peering connection.
\n " + }, + "PeerOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the owner of the peer VPC.
\nDefault: Your AWS account ID
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateVpcPeeringConnectionResult", + "type": "structure", + "members": { + "VpcPeeringConnection": { + "shape_name": "VpcPeeringConnection", + "type": "structure", + "members": { + "AccepterVpcInfo": { + "shape_name": "VpcPeeringConnectionVpcInfo", + "type": "structure", + "members": { + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the peer VPC.
\n ", + "xmlname": "accepterVpcInfo" + }, + "ExpirationTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time that an unaccepted VPC peering connection will expire.
\n ", + "xmlname": "expirationTime" + }, + "RequesterVpcInfo": { + "shape_name": "VpcPeeringConnectionVpcInfo", + "type": "structure", + "members": { + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the requester VPC.
\n ", + "xmlname": "requesterVpcInfo" + }, + "Status": { + "shape_name": "VpcPeeringConnectionStateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nA message that provides more information about the status, if applicable.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "status" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnectionId" + } + }, + "documentation": "\nInformation about the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnection" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nRequests a VPC peering connection between two VPCs: a requester VPC that you own and a peer\n VPC with which to create the connection. The peer VPC can belong to another AWS\n account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.
\nThe owner of the peer VPC must accept the peering request to activate the peering\n connection. The VPC peering connection request expires after 7 days, after which it\n cannot be accepted or rejected.
\nA CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks\n results in the VPC peering connection having a status of failed.
vpc-1a2b3c4d),\n and a VPC (vpc-a1b2c3d4) that belongs to AWS account\n 123456789012. vpc-1a2b3c4d and vpc-11122233.The type of VPN connection.
\n ", + "required": true + }, + "CustomerGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the customer gateway.
\n ", + "required": true + }, + "VpnGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", + "required": true + }, + "Options": { + "shape_name": "VpnConnectionOptionsSpecification", + "type": "structure", + "members": { + "StaticRoutesOnly": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n " + } + }, + "documentation": "\n\t\tIndicates whether the VPN connection requires static routes. If you\n\t\t\t\tare creating a VPN connection for a device that does not support BGP,\n\t\t\t\tyou must specify true.
Default: false
The ID of the VPN connection.
\n ", + "xmlname": "vpnConnectionId" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the VPN connection.
\n ", + "xmlname": "state" + }, + "CustomerGatewayConfiguration": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.
The type of VPN connection.
\n ", + "xmlname": "type" + }, + "CustomerGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the customer gateway at your end of the VPN connection.
\n ", + "xmlname": "customerGatewayId" + }, + "VpnGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway at the AWS side of the VPN connection.
\n ", + "xmlname": "vpnGatewayId" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the VPN connection.
\n ", + "xmlname": "tagSet" + }, + "VgwTelemetry": { + "shape_name": "VgwTelemetryList", + "type": "list", + "members": { + "shape_name": "VgwTelemetry", + "type": "structure", + "members": { + "OutsideIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Internet-routable IP address of the virtual private gateway's outside interface.
\n ", + "xmlname": "outsideIpAddress" + }, + "Status": { + "shape_name": "TelemetryStatus", + "type": "string", + "enum": [ + "UP", + "DOWN" + ], + "documentation": "\n\t\tThe status of the VPN tunnel.
\n ", + "xmlname": "status" + }, + "LastStatusChange": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe date and time of the last change in status.
\n ", + "xmlname": "lastStatusChange" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tIf an error occurs, a description of the error.
\n ", + "xmlname": "statusMessage" + }, + "AcceptedRouteCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of accepted routes.
\n ", + "xmlname": "acceptedRouteCount" + } + }, + "documentation": "\n\t\tDescribes telemetry for a VPN tunnel.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about the VPN tunnel.
\n ", + "xmlname": "vgwTelemetry" + }, + "Options": { + "shape_name": "VpnConnectionOptions", + "type": "structure", + "members": { + "StaticRoutesOnly": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n ", + "xmlname": "staticRoutesOnly" + } + }, + "documentation": "\n\t\tThe VPN connection options.
\n ", + "xmlname": "options" + }, + "Routes": { + "shape_name": "VpnStaticRouteList", + "type": "list", + "members": { + "shape_name": "VpnStaticRoute", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer data center.
\n ", + "xmlname": "destinationCidrBlock" + }, + "Source": { + "shape_name": "VpnStaticRouteSource", + "type": "string", + "enum": [ + "Static" + ], + "documentation": "\n\t\tIndicates how the routes were provided.
\n ", + "xmlname": "source" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the static route.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes a static route for a VPN connection.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe static routes associated with the VPN connection.
\n ", + "xmlname": "routes" + } + }, + "documentation": "\n\t\tInformation about the VPN connection.
\n ", + "xmlname": "vpnConnection" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a VPN connection between an existing virtual private gateway and a VPN customer\n\t\t\t\tgateway. The only supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator \n\t\t to configure your customer gateway.
\nWe strongly recommend that you use HTTPS when calling this operation\n\t\t\t\t\tbecause the response contains sensitive cryptographic information for\n\t\t\t\t\tconfiguring your customer gateway.
\n\t\tIf you decide to shut down your VPN connection for any reason and later create a new VPN\n\t\t\t\tconnection, you must reconfigure your customer gateway with the new information\n\t\t\t\treturned from this call.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvgw-8db04f81 and the customer gateway with the ID cgw-b4dc3961. The response\n\t\t\t\t\tincludes configuration information for the customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t included the complete response here. To see an example of the configuation information,\n\t\t\t\t see the Amazon Virtual Private Cloud Network Administrator Guide.vgw-8db04f81, and the customer\n\t\t\t\t\tgateway with the ID cgw-b4dc3961, for a device that does not support the Border\n\t\t\t\t\tGateway Protocol (BGP). The response includes configuration information for the\n\t\t\t\t\tVPN connection's customer gateway. Because it's a long set of information, we haven't\n\t\t\t\t\tincluded the complete response here.The ID of the VPN connection.
\n ", + "required": true + }, + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer network.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tCreates a static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nvpn-83ad48ea to the destination CIDR block 11.12.0.0/16. Note that\n\t\t\t\t\twhen using the Query API the \"/\" is denoted as \"%2F\".The type of VPN connection this virtual private gateway supports.
\n ", + "required": true + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone for the virtual private gateway.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "CreateVpnGatewayResult", + "type": "structure", + "members": { + "VpnGateway": { + "shape_name": "VpnGateway", + "type": "structure", + "members": { + "VpnGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", + "xmlname": "vpnGatewayId" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the virtual private gateway.
\n ", + "xmlname": "state" + }, + "Type": { + "shape_name": "GatewayType", + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\tThe type of VPN connection the virtual private gateway supports.
\n ", + "xmlname": "type" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone where the virtual private gateway was created.
\n ", + "xmlname": "availabilityZone" + }, + "VpcAttachments": { + "shape_name": "VpcAttachmentList", + "type": "list", + "members": { + "shape_name": "VpcAttachment", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe current state of the attachment.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes an attachment between a virtual private gateway and a VPC.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny VPCs attached to the virtual private gateway.
\n ", + "xmlname": "attachments" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the virtual private gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tInformation about the virtual private gateway.
\n ", + "xmlname": "vpnGateway" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tCreates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your\n\t\t\t\tVPN connection. You can create a virtual private gateway before creating the VPC itself.
\n\t\tFor more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\nThe ID of the customer gateway.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified customer gateway. You must delete the VPN connection before you can delete\n\t\t\t\tthe customer gateway.
\nThe ID of the DHCP options set.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified set of DHCP options. You must disassociate the set of DHCP options\n\t\t\t\tbefore you can delete it. You can disassociate the set of DHCP options by\n\t\t\t\tassociating either a new set of options or the default set of options with the VPC.
\nThe ID of the Internet gateway.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified Internet gateway. You must detach the Internet gateway \n\t\t\t\tfrom the VPC before you can delete it.
\nThe name of the key pair.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDeletes the specified key pair, by removing the public key from Amazon EC2.
\nmy-key-pair.The ID of the network ACL.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. \n\t\t\t\tYou can't delete the default network ACL.
\nThe ID of the network ACL.
\n ", + "required": true + }, + "RuleNumber": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe rule number of the entry to delete.
\n ", + "required": true + }, + "Egress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the rule is an egress rule.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified ingress or egress entry (rule) from the specified network ACL.
\nThe ID of the network interface.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified network interface. You must detach the network interface\n\t\t\t before you can delete it.
\nThe name of the placement group.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDeletes the specified placement group. You must terminate all instances in the\n\t\t\t\tplacement group before you can delete the placement group. For more information about placement groups and\n\t\t\t\tcluster instances, see Cluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nXYZ-cluster.The ID of the route table.
\n ", + "required": true + }, + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range for the route. The value you specify must\n\t\t\t\tmatch the CIDR for the route exactly.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified route from the specified route table.
\n172.16.1.0/24 from the\n\t\t\t\t\tspecified route table.The ID of the route table.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified route table. You must disassociate the route table from any subnets\n\t\t\t\tbefore you can delete it. You can't delete the main route table.
\n[EC2-Classic, default VPC] The name of the security group.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDeletes a security group.
\nIf you attempt to delete a security group that is associated with an instance, or is\n\t\t\t referenced by another security group, the operation fails with\n\t\t\t\tInvalidGroup.InUse in EC2-Classic or\n\t\t\t\tDependencyViolation in EC2-VPC.
The ID of the Amazon EBS snapshot.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDeletes the specified snapshot.
\nWhen you make periodic snapshots of a volume, the snapshots are incremental, and only the\n blocks on the device that have changed since your last snapshot are saved in the new snapshot.\n When you delete a snapshot, only the data not needed for any other snapshot is removed. So\n regardless of which prior snapshots have been deleted, all active snapshots will have access\n to all the information needed to restore the volume.
\nYou cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI.\n You must first de-register the AMI before you can delete the snapshot.
\nFor more information, see Deleting an\n Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.Deletes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nThe ID of the subnet.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified subnet. You must terminate all running instances in the\n\t\t\t\tsubnet before you can delete the subnet.
\nThe ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
\n ", + "required": true, + "flattened": true + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n " + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "Tag" + }, + "documentation": "\nOne or more tags to delete. If you omit the value parameter, we delete the tag regardless\n of its value. If you specify this parameter with an empty string as the\n value, we delete the key only if its value is an empty string.
Deletes the specified set of tags from the specified set of resources. This call is designed\n to follow a DescribeTags request.
For more information about tags, see Tagging\n Your Resources in the Amazon Elastic Compute Cloud User Guide.
\nami-1a2b3c4d.\n First, get a list of the tags by using the DescribeTags request, then delete\n them.stack and webserver tags for two\n particular instances.Purpose, regardless of the tag value.Purpose and the tag value is the empty string.The ID of the volume.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDeletes the specified Amazon EBS volume. The volume must be in the available state (not\n attached to an instance).
The volume may remain in the deleting state for several minutes.
For more information, see Deleting an Amazon EBS\n Volume in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified VPC. You must detach or delete all gateways and resources that are\n\t\t\t\tassociated with the VPC before you can delete it. For example, you must terminate all instances\n\t\t\t\trunning in the VPC, delete all security groups associated with the VPC (except the default one), \n\t\t\t\tdelete all route tables associated with the VPC (except the default one), and so on.
\nThe ID of the VPC peering connection.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DeleteVpcPeeringConnectionResult", + "type": "structure", + "members": { + "Return": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nReturns true if the request succeeds; otherwise, it returns an error.
Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the\n peer VPC can delete the VPC peering connection if it's in the active\n state. The owner of the requester VPC can delete a VPC peering connection in the\n pending-acceptance state.
The ID of the VPN connection.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified VPN connection.
\n\t\tIf you're deleting the VPC and its associated components, we recommend that you\n\t\t\t\tdetach the virtual private gateway from the VPC and delete the VPC before deleting the VPN\n\t\t\t\tconnection.
\nThe ID of the VPN connection.
\n ", + "required": true + }, + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer network.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified static route associated with a VPN connection between an existing\n\t\t\t\tvirtual private gateway and a VPN customer gateway. The static route allows traffic\n\t\t\t\tto be routed from the virtual private gateway to the VPN customer gateway.
\n11.12.0.0/16 associated with the VPN connection with the ID\n\t\t\t\t\tvpn-83ad48ea. Note that when using the Query API, the \"/\" is\n\t\t\t\t\tdenoted as \"%2F\".The ID of the virtual private gateway.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDeletes the specified virtual private gateway. We recommend that before you\n\t\t\t\tdelete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note\n\t\t\t\tthat you don't need to delete the virtual private gateway if you plan to delete and\n\t\t\t\trecreate the VPN connection between your VPC and your network.
\nThe ID of the AMI.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": " \nDeregisters the specified AMI. After you deregister an AMI, it can't be used to launch\n\t\t\t\tnew instances.
\nThis command does not delete the AMI.
\nOne or more account attribute names.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeAccountAttributesResult", + "type": "structure", + "members": { + "AccountAttributes": { + "shape_name": "AccountAttributeList", + "type": "list", + "members": { + "shape_name": "AccountAttribute", + "type": "structure", + "members": { + "AttributeName": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe name of the account attribute.
\n ", + "xmlname": "attributeName" + }, + "AttributeValues": { + "shape_name": "AccountAttributeValueList", + "type": "list", + "members": { + "shape_name": "AccountAttributeValue", + "type": "structure", + "members": { + "AttributeValue": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe value.
\n ", + "xmlname": "attributeValue" + } + }, + "documentation": " \nDescribes a value of an account attribute.
\n ", + "xmlname": "item" + }, + "documentation": " \nOne or more values for the account attribute.
\n ", + "xmlname": "attributeValueSet" + } + }, + "documentation": " \nDescribes an account attribute.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more account attributes.
\n ", + "xmlname": "accountAttributeSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nDescribes the specified attribute of your AWS account.
\n[EC2-Classic] One or more Elastic IP addresses.
\nDefault: Describes all your Elastic IP addresses.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nallocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) \n or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
[EC2-VPC] One or more allocation IDs.
\nDefault: Describes all your Elastic IP addresses.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeAddressesResult", + "type": "structure", + "members": { + "Addresses": { + "shape_name": "AddressList", + "type": "list", + "members": { + "shape_name": "Address", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance the address is associated with (if any).
\n ", + "xmlname": "instanceId" + }, + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Elastic IP address.
\n ", + "xmlname": "publicIp" + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID representing the allocation of the address for use with EC2-VPC.
\n ", + "xmlname": "allocationId" + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID representing the association of the address with an instance in a VPC.
\n ", + "xmlname": "associationId" + }, + "Domain": { + "shape_name": "DomainType", + "type": "string", + "enum": [ + "vpc", + "standard" + ], + "documentation": "\nIndicates whether this Elastic IP address is for use with instances\n\t\t\t\tin EC2-Classic (standard) or instances in a VPC (vpc).
The ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "NetworkInterfaceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AWS account that owns the network interface.
\n ", + "xmlname": "networkInterfaceOwnerId" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe private IP address associated with the Elastic IP address.
\n ", + "xmlname": "privateIpAddress" + } + }, + "documentation": "\nDescribes an Elastic IP address.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more Elastic IP addresses.
\n ", + "xmlname": "addressesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your Elastic IP addresses.
\nAn Elastic IP address is for use in either the EC2-Classic platform or in a VPC.\n\t\t\t\tFor more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
\n192.0.2.1 is assigned to instance i-f15ebb98, \n\t\t\t\t\tand 198.51.100.2 isn't assigned to an instance.The names of one or more Availability Zones.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nmessage - Information about the Availability Zone.
region-name - The name of the region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone\n (available | impaired | unavailable).
zone-name - The name of the Availability Zone (for example, us-east-1a).
The name of the Availability Zone.
\n ", + "xmlname": "zoneName" + }, + "State": { + "shape_name": "AvailabilityZoneState", + "type": "string", + "enum": [ + "available" + ], + "documentation": " \nThe state of the Availability Zone.
\n ", + "xmlname": "zoneState" + }, + "RegionName": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe name of the region.
\n ", + "xmlname": "regionName" + }, + "Messages": { + "shape_name": "AvailabilityZoneMessageList", + "type": "list", + "members": { + "shape_name": "AvailabilityZoneMessage", + "type": "structure", + "members": { + "Message": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe message about the Availability Zone.
\n ", + "xmlname": "message" + } + }, + "documentation": " \nDescribes a message about an Availability Zone.
\n ", + "xmlname": "item" + }, + "documentation": " \nAny messages about the Availability Zone.
\n ", + "xmlname": "messageSet" + } + }, + "documentation": " \nDescribes an Availability Zone.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more Availability Zones.
\n ", + "xmlname": "availabilityZoneInfo" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nDescribes one or more of the Availability Zones that are available to you. The results\n\t\t\t\tinclude zones only for the region you're currently using. If there is an event\n\t\t\t\timpacting an Availability Zone, you can use this request to view the state and any\n\t\t\t\tprovided message for that Availability Zone.
\nFor more information, see Regions and Availability Zones\n in the Amazon Elastic Compute Cloud User Guide.
\nOne or more bundle task IDs.
\nDefault: Describes all your bundle tasks.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nbundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling |\n storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
The ID of the instance associated with this bundle task.
\n ", + "xmlname": "instanceId" + }, + "BundleId": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe ID for this bundle task.
\n ", + "xmlname": "bundleId" + }, + "State": { + "shape_name": "BundleTaskState", + "type": "string", + "enum": [ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ], + "documentation": " \nThe state of the task.
\n ", + "xmlname": "state" + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time this task started.
\n ", + "xmlname": "startTime" + }, + "UpdateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": " \nThe time of the most recent update for the task.
\n ", + "xmlname": "updateTime" + }, + "Storage": { + "shape_name": "Storage", + "type": "structure", + "members": { + "S3": { + "shape_name": "S3Storage", + "type": "structure", + "members": { + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
\n ", + "xmlname": "bucket" + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe beginning of the file name of the AMI.
\n ", + "xmlname": "prefix" + }, + "AWSAccessKeyId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance \n in Best Practices for Managing AWS Access Keys.
\n " + }, + "UploadPolicy": { + "shape_name": "String", + "type": "string", + "documentation": "\nA Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
\n ", + "xmlname": "uploadPolicy" + }, + "UploadPolicySignature": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe signature of the Base64 encoded JSON document.
\n ", + "xmlname": "uploadPolicySignature" + } + }, + "documentation": "\nAn Amazon S3 storage location.
\n " + } + }, + "documentation": " \nThe Amazon S3 storage locations.
\n ", + "xmlname": "storage" + }, + "Progress": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe level of task completion, as a percent (for example, 20%).
\n ", + "xmlname": "progress" + }, + "BundleTaskError": { + "shape_name": "BundleTaskError", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error code.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": " \nThe error message.
\n ", + "xmlname": "message" + } + }, + "documentation": " \nIf the task fails, a description of the error.
\n ", + "xmlname": "error" + } + }, + "documentation": " \nDescribes a bundle task.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more bundle tasks.
\n ", + "xmlname": "bundleInstanceTasksSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nDescribes one or more of your bundling tasks.
\nCompleted bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.
complete or failed, and in addition are targeted for the Amazon S3 bucket named myawsbucket.The name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n ", + "flattened": true + }, + "ConversionTaskIds": { + "shape_name": "ConversionIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ConversionTaskId" + }, + "documentation": "\nOne or more conversion task IDs.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeConversionTasksResult", + "type": "structure", + "members": { + "ConversionTasks": { + "shape_name": "DescribeConversionTaskList", + "type": "list", + "members": { + "shape_name": "ConversionTask", + "type": "structure", + "members": { + "ConversionTaskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the conversion task.
\n ", + "required": true, + "xmlname": "conversionTaskId" + }, + "ExpirationTime": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\n ", + "xmlname": "expirationTime" + }, + "ImportInstance": { + "shape_name": "ImportInstanceTaskDetails", + "type": "structure", + "members": { + "Volumes": { + "shape_name": "ImportInstanceVolumeDetailSet", + "type": "list", + "members": { + "shape_name": "ImportInstanceVolumeDetailItem", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the import of this particular disk image.
\n ", + "required": true, + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status information or errors related to the disk image.
\n ", + "xmlname": "statusMessage" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nDescribes an import volume task.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "required": true, + "xmlname": "volumes" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "instanceId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe instance operating system.
\n ", + "xmlname": "platform" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", + "xmlname": "importInstance" + }, + "ImportVolume": { + "shape_name": "ImportVolumeTaskDetails", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description you provided when starting the import volume task.
\n ", + "xmlname": "description" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + } + }, + "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", + "xmlname": "importVolume" + }, + "State": { + "shape_name": "ConversionTaskState", + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the conversion task.
\n ", + "required": true, + "xmlname": "state" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status message related to the conversion task.
\n ", + "xmlname": "statusMessage" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\nDescribes a conversion task.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "conversionTasks" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your conversion tasks. For more information, see Using the Command Line\n Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.
\nOne or more customer gateway IDs.
\n\t\tDefault: Describes all your customer gateways.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tbgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the customer gateway.
\n ", + "xmlname": "customerGatewayId" + }, + "State": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe current state of the customer gateway.
\n ", + "xmlname": "state" + }, + "Type": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe type of VPN connection the customer gateway supports.
\n ", + "xmlname": "type" + }, + "IpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Internet-routable IP address of the customer gateway's outside interface.
\n ", + "xmlname": "ipAddress" + }, + "BgpAsn": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
\n ", + "xmlname": "bgpAsn" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the customer gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes a customer gateway.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more customer gateways.
\n ", + "xmlname": "customerGatewaySet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your VPN customer gateways.
\n\t\tFor more information about VPN customer gateways, see\n\t\t\t\tAdding a Hardware\n\t\t\t\tVirtual Private Gateway to Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n12.1.2.3, and whose state is either pending\n\t\t\t\t\tor available.The IDs of one or more DHCP options sets.
\n\t\tDefault: Describes all your DHCP options sets.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tdhcp-options-id - The ID of a set of DHCP options.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the set of DHCP options.
\n ", + "xmlname": "dhcpOptionsId" + }, + "DhcpConfigurations": { + "shape_name": "DhcpConfigurationList", + "type": "list", + "members": { + "shape_name": "DhcpConfiguration", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe name of a DHCP option.
\n ", + "xmlname": "key" + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more values for the DHCP option.
\n ", + "xmlname": "valueSet" + } + }, + "documentation": "\n\t\tDescribes a DHCP configuration option.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more DHCP options in the set.
\n ", + "xmlname": "dhcpConfigurationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the DHCP options set.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes a set of DHCP options.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more DHCP options sets.
\n ", + "xmlname": "dhcpOptionsSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your DHCP options sets.
\n\t\tFor more information about DHCP options sets, see DHCP Options Sets\n\t\t\t\tin the Amazon Virtual Private Cloud User Guide.
\ndomain-name option whose value includes the string\n\t\t\t\t\texample.One or more export task IDs.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeExportTasksResult", + "type": "structure", + "members": { + "ExportTasks": { + "shape_name": "ExportTaskList", + "type": "list", + "members": { + "shape_name": "ExportTask", + "type": "structure", + "members": { + "ExportTaskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the export task.
\n ", + "xmlname": "exportTaskId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the resource being exported.
\n ", + "xmlname": "description" + }, + "State": { + "shape_name": "ExportTaskState", + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the conversion task.
\n ", + "xmlname": "state" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status message related to the export task.
\n ", + "xmlname": "statusMessage" + }, + "InstanceExportDetails": { + "shape_name": "InstanceExportDetails", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the resource being exported.
\n ", + "xmlname": "instanceId" + }, + "TargetEnvironment": { + "shape_name": "ExportEnvironment", + "type": "string", + "enum": [ + "citrix", + "vmware", + "microsoft" + ], + "documentation": "\nThe target virtualization environment.
\n ", + "xmlname": "targetEnvironment" + } + }, + "documentation": "\nThe instance being exported.
\n ", + "xmlname": "instanceExport" + }, + "ExportToS3Task": { + "shape_name": "ExportToS3Task", + "type": "structure", + "members": { + "DiskImageFormat": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe format for the exported image.
\n ", + "xmlname": "diskImageFormat" + }, + "ContainerFormat": { + "shape_name": "ContainerFormat", + "type": "string", + "enum": [ + "ova" + ], + "documentation": "\nThe container format used to combine disk images with metadata (such as OVF). If absent, only\n the disk image is exported.
\n ", + "xmlname": "containerFormat" + }, + "S3Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon S3 bucket for the destination image. The destination bucket must\n exist and grant WRITE and READ_ACL permissions to the AWS account\n vm-import-export@amazon.com.
Describes an export task.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "exportTaskSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your export tasks.
\nThe ID of the AMI.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "ImageAttributeName", + "type": "string", + "enum": [ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping" + ], + "documentation": "\nThe AMI attribute.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ImageAttribute", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI.
\n ", + "xmlname": "imageId" + }, + "LaunchPermissions": { + "shape_name": "LaunchPermissionList", + "type": "list", + "members": { + "shape_name": "LaunchPermission", + "type": "structure", + "members": { + "UserId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID.
\n ", + "xmlname": "userId" + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe name of the group.
\n ", + "xmlname": "group" + } + }, + "documentation": "\nDescribes a launch permission.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more launch permissions.
\n ", + "xmlname": "launchPermission" + }, + "ProductCodes": { + "shape_name": "ProductCodeList", + "type": "list", + "members": { + "shape_name": "ProductCode", + "type": "structure", + "members": { + "ProductCodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more product codes.
\n ", + "xmlname": "productCodes" + }, + "KernelId": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe kernel ID.
\n ", + "xmlname": "kernel" + }, + "RamdiskId": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe RAM disk ID.
\n ", + "xmlname": "ramdisk" + }, + "Description": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nA description for the AMI.
\n ", + "xmlname": "description" + }, + "SriovNetSupport": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": " \n ", + "xmlname": "sriovNetSupport" + }, + "BlockDeviceMappings": { + "shape_name": "BlockDeviceMappingList", + "type": "list", + "members": { + "shape_name": "BlockDeviceMapping", + "type": "structure", + "members": { + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n ", + "xmlname": "virtualName" + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", + "xmlname": "volumeSize" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", + "xmlname": "noDevice" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more block device mapping entries.
\n ", + "xmlname": "blockDeviceMapping" + } + }, + "documentation": "\nInformation about the image attribute.
\n ", + "xmlname": "imageAttribute" + }, + "errors": [], + "documentation": " \nDescribes the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nOne or more image IDs.
\nDefault: Describes all images available to you.
\n ", + "flattened": true + }, + "Owners": { + "shape_name": "OwnerStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Owner" + }, + "documentation": "\nFilters the images by the owner. \n\t\t\t\tSpecify an AWS account ID, amazon (owner is Amazon), \n\t\t\t\taws-marketplace (owner is AWS Marketplace), \n\t\t\t\tself (owner is the sender of the request), or\n\t\t\t\tall (all owners).
Scopes the images by users with explicit launch permissions. \n\t\t\t\tSpecify an AWS account ID, self (the sender of the request),\n\t\t\t\tor all (public AMIs).
The name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\narchitecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates \n whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume\n (gp2 | standard | io1).
description - The description of the image (provided during image creation).
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The AWS account alias (for example, amazon).
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned \n both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
virtualization-type - The virtualization type (paravirtual | hvm).
The ID of the AMI.
\n ", + "xmlname": "imageId" + }, + "ImageLocation": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe location of the AMI.
\n ", + "xmlname": "imageLocation" + }, + "State": { + "shape_name": "ImageState", + "type": "string", + "enum": [ + "available", + "deregistered" + ], + "documentation": "\nThe current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
The AWS account ID of the image owner.
\n ", + "xmlname": "imageOwnerId" + }, + "Public": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the image has public launch permissions. The value is true if\n\t\t\t\tthis image has public launch permissions or false\n\t\t\t\tif it has only implicit and explicit launch permissions.
The product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny product codes associated with the AMI.
\n ", + "xmlname": "productCodes" + }, + "Architecture": { + "shape_name": "ArchitectureValues", + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\nThe architecture of the image.
\n ", + "xmlname": "architecture" + }, + "ImageType": { + "shape_name": "ImageTypeValues", + "type": "string", + "enum": [ + "machine", + "kernel", + "ramdisk" + ], + "documentation": "\nThe type of image.
\n ", + "xmlname": "imageType" + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe kernel associated with the image, if any. Only applicable for machine images.
\n ", + "xmlname": "kernelId" + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe RAM disk associated with the image, if any. Only applicable for machine images.
\n ", + "xmlname": "ramdiskId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe value is Windows for Windows AMIs; otherwise blank.
Specifies whether enhanced networking is enabled.
\n ", + "xmlname": "sriovNetSupport" + }, + "StateReason": { + "shape_name": "StateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the state change.
\n ", + "xmlname": "stateReason" + }, + "ImageOwnerAlias": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account alias (for example, amazon, self) or\n the AWS account ID of the AMI owner.
The name of the AMI that was provided during image creation.
\n ", + "xmlname": "name" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the AMI that was provided during image creation.
\n ", + "xmlname": "description" + }, + "RootDeviceType": { + "shape_name": "DeviceType", + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\nThe type of root device used by the AMI. The AMI can use an Amazon EBS volume or an\n\t\t\t\tinstance store volume.
\n ", + "xmlname": "rootDeviceType" + }, + "RootDeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name of the root device (for example,
The virtual device name.
\n ", + "xmlname": "virtualName" + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", + "xmlname": "volumeSize" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", + "xmlname": "noDevice" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny block device mapping entries.
\n ", + "xmlname": "blockDeviceMapping" + }, + "VirtualizationType": { + "shape_name": "VirtualizationType", + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\nThe type of virtualization of the AMI.
\n ", + "xmlname": "virtualizationType" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the image.
\n ", + "xmlname": "tagSet" + }, + "Hypervisor": { + "shape_name": "HypervisorType", + "type": "string", + "enum": [ + "ovm", + "xen" + ], + "documentation": "\nThe hypervisor type of the image.
\n ", + "xmlname": "hypervisor" + } + }, + "documentation": "\nDescribes an image.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more images.
\n ", + "xmlname": "imagesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nDescribes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to\n\t\t\t\tyou include public images, private images that you own, and private images owned by\n\t\t\t\tother AWS accounts but for which you have explicit launch permissions.
\nDeregistered images are included in the returned results for an unspecified interval after deregistration.
x86_64 architecture.aws-marketplace.The ID of the instance.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "InstanceAttributeName", + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\nThe instance attribute.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "InstanceAttribute", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "InstanceType": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "KernelId": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe kernel ID.
\n ", + "xmlname": "kernel" + }, + "RamdiskId": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe RAM disk ID.
\n ", + "xmlname": "ramdisk" + }, + "UserData": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe Base64-encoded MIME user data.
\n ", + "xmlname": "userData" + }, + "DisableApiTermination": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nIf the value is true, you can't terminate the instance through the Amazon EC2\n\t\t\t\tconsole, CLI, or API; otherwise, you can.
Indicates whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).
\n ", + "xmlname": "instanceInitiatedShutdownBehavior" + }, + "RootDeviceName": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe name of the root device (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", + "xmlname": "volumeId" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe block device mapping of the instance.
\n ", + "xmlname": "blockDeviceMapping" + }, + "ProductCodes": { + "shape_name": "ProductCodeList", + "type": "list", + "members": { + "shape_name": "ProductCode", + "type": "structure", + "members": { + "ProductCodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of product codes.
\n ", + "xmlname": "productCodes" + }, + "EbsOptimized": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nIndicates whether the instance is optimized for EBS I/O.
\n ", + "xmlname": "ebsOptimized" + }, + "SriovNetSupport": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": " \n ", + "xmlname": "sriovNetSupport" + }, + "SourceDestCheck": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nIndicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled.\n This value must be false for a NAT instance to perform NAT.
\n ", + "xmlname": "sourceDestCheck" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the specified attribute of the specified instance. You can specify only one\n\t\t\t\tattribute at a time.
\nInstanceInitiatedShutdownBehavior attribute for the specified instance.DisableApiTermination attribute for the specified instance.One or more instance IDs.
\nDefault: Describes all your instances.
\nConstraints: Maximum 100 explicitly specified instance IDs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone of the instance.
event.code - The code identifying the type of event (instance-reboot | system-reboot |\n system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.not-after - The latest end time for the scheduled event.
event.not-before - The earliest start time for the scheduled event.
instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented.\n The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down |\n terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed |\n failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing |\n insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed |\n failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing |\n insufficient-data | not-applicable).
The next paginated set of results to return.
\n " + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of paginated instance items per response.
\nDefault: 1000
\n " + }, + "IncludeAllInstances": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhen true, includes the health status for all instances.\n\t\t\t\tWhen false, includes the health status for running instances only.
Default: false
The ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone of the instance.
\n ", + "xmlname": "availabilityZone" + }, + "Events": { + "shape_name": "InstanceStatusEventList", + "type": "list", + "members": { + "shape_name": "InstanceStatusEvent", + "type": "structure", + "members": { + "Code": { + "shape_name": "EventCode", + "type": "string", + "enum": [ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ], + "documentation": "\nThe associated code of the event.
\n ", + "xmlname": "code" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the event.
\n ", + "xmlname": "description" + }, + "NotBefore": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe earliest scheduled start time for the event.
\n ", + "xmlname": "notBefore" + }, + "NotAfter": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe latest scheduled end time for the event.
\n ", + "xmlname": "notAfter" + } + }, + "documentation": "\nDescribes an instance event.
\n ", + "xmlname": "item" + }, + "documentation": "\nExtra information regarding events associated with the instance.
\n ", + "xmlname": "eventsSet" + }, + "InstanceState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe intended state of the instance.\n\t\t\t\tDescribeInstanceStatus requires that an\n\t\t\t\tinstance be in the running state.
The status.
\n ", + "xmlname": "status" + }, + "Details": { + "shape_name": "InstanceStatusDetailsList", + "type": "list", + "members": { + "shape_name": "InstanceStatusDetails", + "type": "structure", + "members": { + "Name": { + "shape_name": "StatusName", + "type": "string", + "enum": [ + "reachability" + ], + "documentation": "\nThe type of instance status.
\n ", + "xmlname": "name" + }, + "Status": { + "shape_name": "StatusType", + "type": "string", + "enum": [ + "passed", + "failed", + "insufficient-data" + ], + "documentation": "\nThe status.
\n ", + "xmlname": "status" + }, + "ImpairedSince": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.
\n ", + "xmlname": "impairedSince" + } + }, + "documentation": "\nDescribes the instance status.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe system instance health or application instance health.
\n ", + "xmlname": "details" + } + }, + "documentation": "\nReports impaired functionality that stems from issues related to the systems that\n\t\t\t\tsupport an instance, such as hardware failures and network connectivity problems.
\n ", + "xmlname": "systemStatus" + }, + "InstanceStatus": { + "shape_name": "InstanceStatusSummary", + "type": "structure", + "members": { + "Status": { + "shape_name": "SummaryStatus", + "type": "string", + "enum": [ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ], + "documentation": "\nThe status.
\n ", + "xmlname": "status" + }, + "Details": { + "shape_name": "InstanceStatusDetailsList", + "type": "list", + "members": { + "shape_name": "InstanceStatusDetails", + "type": "structure", + "members": { + "Name": { + "shape_name": "StatusName", + "type": "string", + "enum": [ + "reachability" + ], + "documentation": "\nThe type of instance status.
\n ", + "xmlname": "name" + }, + "Status": { + "shape_name": "StatusType", + "type": "string", + "enum": [ + "passed", + "failed", + "insufficient-data" + ], + "documentation": "\nThe status.
\n ", + "xmlname": "status" + }, + "ImpairedSince": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time when a status check failed. For an instance that was launched and\n\t\t\t\timpaired, this is the time when the instance was launched.
\n ", + "xmlname": "impairedSince" + } + }, + "documentation": "\nDescribes the instance status.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe system instance health or application instance health.
\n ", + "xmlname": "details" + } + }, + "documentation": "\nReports impaired functionality that stems from issues internal to the instance,\n\t\t\t\tsuch as impaired reachability.
\n ", + "xmlname": "instanceStatus" + } + }, + "documentation": "\nDescribes the status of an instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more instance status descriptions.
\n ", + "xmlname": "instanceStatusSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe next paginated set of results to return.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the status of one or more instances, including any scheduled events.
\n\t\t\tInstance status has two main components:
\n\t\t\tSystem Status reports impaired functionality that stems from issues\n\t\t\t\t\t\trelated to the systems that support an instance, such as such as hardware\n\t\t\t\t\t\tfailures and network connectivity problems. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.
\n\t\t\t\tInstance Status reports impaired functionality that arises from\n\t\t\t\t\t\tproblems internal to the instance. This call reports\n\t\t\t\t\t\tsuch problems as impaired reachability.
\n\t\t\t\tInstance status provides information about four types of scheduled events for an\n instance that may require your attention:
\n\t\t\tScheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the\n\t\t\t\t\t\tinstances status returns one of two event codes:\n\t\t\t\t\t\tsystem-reboot or instance-reboot. System\n\t\t\t\t\t\treboot commonly occurs if certain maintenance or upgrade operations require\n\t\t\t\t\t\ta reboot of the underlying host that supports an instance. Instance reboot\n\t\t\t\t\t\tcommonly occurs if the instance must be rebooted, rather than the underlying\n\t\t\t\t\t\thost. Rebooting events include a scheduled start and end time.
System Maintenance: When Amazon EC2 determines that an instance requires maintenance that\n\t\t\t\t\t\trequires power or network impact, the instance status is the event\n\t\t\t\t\t\tcode system-maintenance. System maintenance is either\n\t\t\t\t\t\tpower maintenance or network maintenance. For power maintenance, your\n\t\t\t\t\t\tinstance will be unavailable for a brief period of time and then rebooted.\n\t\t\t\t\t\tFor network maintenance, your instance will experience a brief loss of\n\t\t\t\t\t\tnetwork connectivity. System maintenance events include a scheduled start\n\t\t\t\t\t\tand end time. You will also be notified by email if one of your instances is\n\t\t\t\t\t\tset for system maintenance. The email message indicates when your instance\n\t\t\t\t\t\tis scheduled for maintenance.
Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstance status is the event code\n\t\t\t\t\t\tinstance-retirement. Retirement commonly occurs when the\n\t\t\t\t\t\tunderlying host is degraded and must be replaced. Retirement events include\n\t\t\t\t\t\ta scheduled start and end time. You will also be notified by email if one of\n\t\t\t\t\t\tyour instances is set to retiring. The email message indicates when your\n\t\t\t\t\t\tinstance will be permanently retired.
Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the\n\t\t\t\t\t\tinstances status returns an event code called instance-stop.\n\t\t\t\t\t\tStop events include a scheduled start and end time. You will also be\n\t\t\t\t\t\tnotified by email if one of your instances is set to stop. The email message\n\t\t\t\t\t\tindicates when your instance will be stopped.
When your instance is retired, it will either be terminated (if its root device type is the\n\t\t\t\tinstance-store) or stopped (if its root device type is an EBS volume). Instances\n\t\t\t\tstopped due to retirement will not be restarted, but you can do so manually. You can\n\t\t\t\talso avoid retirement of EBS-backed instances by manually restarting your instance\n\t\t\t\twhen its event code is instance-retirement. This ensures that your\n\t\t\t\tinstance is started on a different underlying host.
For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide.
\n16\n instance-retirement\n 16\n instance-reboot\n 16\n 16\n One or more instance IDs.
\nDefault: Describes all your instances.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\narchitecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached |\n detaching | detached).
block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.
group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.
hypervisor - The hypervisor type of the instance (ovm |\n\t\t\t\t\t\txen).
iam-instance-profile.arn - The instance profile associated with the\n\t\t\t\t\tinstance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance (spot).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, m1.small).
instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.
instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.
ip-address - The public IP address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched.
monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.
private-dns-name - The private DNS name of the instance.
private-ip-address - The private IP address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.
root-device-name - The name of the root device for the instance (for example, /dev/sda1).
root-device-type - The type of root device that the instance uses (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:key=value - The key/value combination of a tag assigned to\n the resource, where tag:key is the tag's key.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter.\n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both\n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is).\n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is\n\t\t\t\t\tindependent of the tag-key filter.
tenancy - The tenancy of an instance (dedicated |\n\t\t\t\t\t\tdefault).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
network-interface.description - The description of the network interface.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
network-interface.network-interface.id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.mac-address - The MAC address of the network interface.
network-interface-private-dns-name - The private DNS name of the network interface.
network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.addresses.private-ip-address - The private IP address associated with the network interface.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
The token for the next set of items to return. (You received this token from a prior call.)
\n " + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe 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. If the value is greater than 1000, we return only 1000 items.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeInstancesResult", + "type": "structure", + "members": { + "Reservations": { + "shape_name": "ReservationList", + "type": "list", + "members": { + "shape_name": "Reservation", + "type": "structure", + "members": { + "ReservationId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the reservation.
\n ", + "xmlname": "reservationId" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AWS account that owns the reservation.
\n ", + "xmlname": "ownerId" + }, + "RequesterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).
\n ", + "xmlname": "requesterId" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "Instances": { + "shape_name": "InstanceList", + "type": "list", + "members": { + "shape_name": "Instance", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI used to launch the instance.
\n ", + "xmlname": "imageId" + }, + "State": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe current state of the instance.
\n ", + "xmlname": "instanceState" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe running state.
The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
\n ", + "xmlname": "reason" + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair, if this instance was launched with an associated key pair.
\n ", + "xmlname": "keyName" + }, + "AmiLaunchIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe AMI launch index, which can be used to find this instance in the launch group.
\n ", + "xmlname": "amiLaunchIndex" + }, + "ProductCodes": { + "shape_name": "ProductCodeList", + "type": "list", + "members": { + "shape_name": "ProductCode", + "type": "structure", + "members": { + "ProductCodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe product codes attached to this instance.
\n ", + "xmlname": "productCodes" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "LaunchTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the instance was launched.
\n ", + "xmlname": "launchTime" + }, + "Placement": { + "shape_name": "Placement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone of the instance.
\n ", + "xmlname": "availabilityZone" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n ", + "xmlname": "groupName" + }, + "Tenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The location where the instance launched.
\n ", + "xmlname": "placement" + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe kernel associated with this instance.
\n ", + "xmlname": "kernelId" + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe RAM disk associated with this instance.
\n ", + "xmlname": "ramdiskId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe value is Windows for Windows instances; otherwise blank.
Indicates whether monitoring is enabled for the instance.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nThe monitoring information for the instance.
\n ", + "xmlname": "monitoring" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the subnet in which the instance is running.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC in which the instance is running.
\n ", + "xmlname": "vpcId" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe private IP address assigned to the instance.
\n ", + "xmlname": "privateIpAddress" + }, + "PublicIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe public IP address assigned to the instance.
\n ", + "xmlname": "ipAddress" + }, + "StateReason": { + "shape_name": "StateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the most recent state transition.
\n ", + "xmlname": "stateReason" + }, + "Architecture": { + "shape_name": "ArchitectureValues", + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\nThe architecture of the image.
\n ", + "xmlname": "architecture" + }, + "RootDeviceType": { + "shape_name": "DeviceType", + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\nThe root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.
\n ", + "xmlname": "rootDeviceType" + }, + "RootDeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe root device name (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", + "xmlname": "volumeId" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny block device mapping entries for the instance.
\n ", + "xmlname": "blockDeviceMapping" + }, + "VirtualizationType": { + "shape_name": "VirtualizationType", + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\nThe virtualization type of the instance.
\n ", + "xmlname": "virtualizationType" + }, + "InstanceLifecycle": { + "shape_name": "InstanceLifecycleType", + "type": "string", + "enum": [ + "spot" + ], + "documentation": "\nIndicates whether this is a Spot Instance.
\n ", + "xmlname": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestId" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe idempotency token you provided when you launched the instance.
\n ", + "xmlname": "clientToken" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the instance.
\n ", + "xmlname": "tagSet" + }, + "SecurityGroups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups for the instance.
\n ", + "xmlname": "groupSet" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
\n ", + "xmlname": "hypervisor" + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterface", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description.
\n ", + "xmlname": "description" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the AWS account that created the network interface.
\n ", + "xmlname": "ownerId" + }, + "Status": { + "shape_name": "NetworkInterfaceStatus", + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\tThe status of the network interface.
\n ", + "xmlname": "status" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether to validate network traffic to or from this network interface.
\n ", + "xmlname": "sourceDestCheck" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "Attachment": { + "shape_name": "InstanceNetworkInterfaceAttachment", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", + "xmlname": "deviceIndex" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n\t\tThe network interface attachment.
\n ", + "xmlname": "attachment" + }, + "Association": { + "shape_name": "InstanceNetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n ", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", + "xmlname": "ipOwnerId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", + "xmlname": "association" + }, + "PrivateIpAddresses": { + "shape_name": "InstancePrivateIpAddressList", + "type": "list", + "members": { + "shape_name": "InstancePrivateIpAddress", + "type": "structure", + "members": { + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address \n\t\t of the network interface.
\n ", + "xmlname": "primary" + }, + "Association": { + "shape_name": "InstanceNetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n ", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", + "xmlname": "ipOwnerId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP address for the network interface.
\n ", + "xmlname": "association" + } + }, + "documentation": "\n\t\tDescribes a private IP address.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n[EC2-VPC] One or more network interfaces for the instance.
\n ", + "xmlname": "networkInterfaceSet" + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfile", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", + "xmlname": "arn" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance profile.
\n ", + "xmlname": "id" + } + }, + "documentation": "\nThe IAM instance profile associated with the instance.
\n ", + "xmlname": "iamInstanceProfile" + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.
\n ", + "xmlname": "ebsOptimized" + }, + "SriovNetSupport": { + "shape_name": "String", + "type": "string", + "documentation": "\nSpecifies whether enhanced networking is enabled.
\n ", + "xmlname": "sriovNetSupport" + } + }, + "documentation": "\nDescribes an instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\nDescribes a reservation.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more reservations.
\n ", + "xmlname": "reservationSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your instances.
\nIf you specify one or more instance IDs, Amazon EC2 returns information for those\n instances. If you do not specify instance IDs, Amazon EC2 returns information for\n all relevant instances. If you specify an instance ID that is not valid, an error is returned.\n If you specify an instance that you do not own, it is not included in the returned\n results.
\nRecently terminated instances might appear in the returned results. This interval\n is usually less than one hour.
\nm1.small or m1.large instance type and an attached Amazon EBS volume that will be deleted on termination.Owner,\n regardless of the value of the tag.Owner and the value DbAdmin.One or more Internet gateway IDs.
\n\t\tDefault: Describes all your Internet gateways.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tattachment.state - The current state of the attachment between the gateway and the VPC. Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
The ID of the Internet gateway.
\n ", + "xmlname": "internetGatewayId" + }, + "Attachments": { + "shape_name": "InternetGatewayAttachmentList", + "type": "list", + "members": { + "shape_name": "InternetGatewayAttachment", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe current state of the attachment.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes the attachment of a VPC to an Internet gateway.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny VPCs attached to the Internet gateway.
\n ", + "xmlname": "attachmentSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the Internet gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes an Internet gateway.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more Internet gateways.
\n ", + "xmlname": "internetGatewaySet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your Internet gateways.
\nOne or more key pair names.
\nDefault: Describes all your key pairs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nfingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
The name of the key pair.
\n ", + "xmlname": "keyName" + }, + "KeyFingerprint": { + "shape_name": "String", + "type": "string", + "documentation": "\nIf you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. \n If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
\n ", + "xmlname": "keyFingerprint" + } + }, + "documentation": "\nDescribes a key pair.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more key pairs.
\n ", + "xmlname": "keySet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your key pairs.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nDave.One or more network ACL IDs.
\n\t\tDefault: Describes all your network ACLs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tassociation.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The CIDR range specified in the entry.
entry.egress - Indicates whether the entry applies to egress traffic.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.
network-acl-id - The ID of the network ACL.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network ACL.
The ID of the network ACL.
\n ", + "xmlname": "networkAclId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC for the network ACL.
\n ", + "xmlname": "vpcId" + }, + "IsDefault": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the default network ACL for the VPC.
\n ", + "xmlname": "default" + }, + "Entries": { + "shape_name": "NetworkAclEntryList", + "type": "list", + "members": { + "shape_name": "NetworkAclEntry", + "type": "structure", + "members": { + "RuleNumber": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe rule number for the entry. ACL entries are processed in ascending order by rule number.
\n ", + "xmlname": "ruleNumber" + }, + "Protocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol. A value of -1 means all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", + "xmlname": "ruleAction" + }, + "Egress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the rule is an egress rule (applied to traffic leaving the subnet).
\n ", + "xmlname": "egress" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", + "xmlname": "cidrBlock" + }, + "IcmpTypeCode": { + "shape_name": "IcmpTypeCode", + "type": "structure", + "members": { + "Type": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n ", + "xmlname": "type" + }, + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n ", + "xmlname": "code" + } + }, + "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", + "xmlname": "icmpTypeCode" + }, + "PortRange": { + "shape_name": "PortRange", + "type": "structure", + "members": { + "From": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe first port in the range.
\n ", + "xmlname": "from" + }, + "To": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe last port in the range.
\n ", + "xmlname": "to" + } + }, + "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n ", + "xmlname": "portRange" + } + }, + "documentation": "\n\t\tDescribes an entry in a network ACL.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more entries (rules) in the network ACL.
\n ", + "xmlname": "entrySet" + }, + "Associations": { + "shape_name": "NetworkAclAssociationList", + "type": "list", + "members": { + "shape_name": "NetworkAclAssociation", + "type": "structure", + "members": { + "NetworkAclAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the association between a network ACL and a subnet.
\n ", + "xmlname": "networkAclAssociationId" + }, + "NetworkAclId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network ACL.
\n ", + "xmlname": "networkAclId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + } + }, + "documentation": "\n\t\tDescribes an association between a network ACL and a subnet.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny associations between the network ACL and one or more subnets
\n ", + "xmlname": "associationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the network ACL.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes a network ACL.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more network ACLs.
\n ", + "xmlname": "networkAclSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your network ACLs.
\n\t\tFor more information about network ACLs, see Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\nThe ID of the network interface.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "NetworkInterfaceAttribute", + "type": "string", + "enum": [ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ], + "documentation": "\nThe attribute of the network interface.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeNetworkInterfaceAttributeResult", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "Description": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\n\t\tThe description of the network interface.
\n ", + "xmlname": "description" + }, + "SourceDestCheck": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\n\t\tIndicates whether source/destination checking is enabled.
\n ", + "xmlname": "sourceDestCheck" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe security groups associated with the network interface.
\n ", + "xmlname": "groupSet" + }, + "Attachment": { + "shape_name": "NetworkInterfaceAttachment", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "InstanceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", + "xmlname": "instanceOwnerId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", + "xmlname": "deviceIndex" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n\t\tThe attachment (if any) of the network interface.
\n ", + "xmlname": "attachment" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes a network interface attribute. You can specify only one attribute at a\n\t\t\t\ttime.
\nsourceDestCheck attribute of the specified network interface.One or more network interface IDs.
\n\t\tDefault: Describes all your network interfaces.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\taddresses.private-ip-address - The private IP addresses associated with the network interface.
addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IP address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.
association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.
association.public-ip - The address of the Elastic IP address bound to the network interface.
association.public-dns-name - The public DNS name for the network interface.
attachment.attachment-id - The ID of the interface attachment.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.device-index - The device index to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
attachment.attach.time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IP address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-desk-check - Indicates whether the network interface performs source/destination checking. \n\t\t A value of true means checking is enabled, and false means checking is disabled. \n\t\t The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; \n\t\t if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the network interface.
The ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone.
\n ", + "xmlname": "availabilityZone" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tA description.
\n ", + "xmlname": "description" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the network interface.
\n ", + "xmlname": "ownerId" + }, + "RequesterId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the entity that launched the instance on your behalf (for example, AWS\n\t\t\t\tManagement Console or Auto Scaling).
\n ", + "xmlname": "requesterId" + }, + "RequesterManaged": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is being managed by AWS.
\n ", + "xmlname": "requesterManaged" + }, + "Status": { + "shape_name": "NetworkInterfaceStatus", + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\tThe status of the network interface.
\n ", + "xmlname": "status" + }, + "MacAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe MAC address.
\n ", + "xmlname": "macAddress" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether traffic to or from the instance is validated.
\n ", + "xmlname": "sourceDestCheck" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny security groups for the network interface.
\n ", + "xmlname": "groupSet" + }, + "Attachment": { + "shape_name": "NetworkInterfaceAttachment", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "InstanceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", + "xmlname": "instanceOwnerId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe device index of the network interface attachment on the instance.
\n ", + "xmlname": "deviceIndex" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe timestamp indicating when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n\t\tThe network interface attachment.
\n ", + "xmlname": "attachment" + }, + "Association": { + "shape_name": "NetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n\t", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", + "xmlname": "ipOwnerId" + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe allocation ID.
\n ", + "xmlname": "allocationId" + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe association ID.
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", + "xmlname": "association" + }, + "TagSet": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the network interface.
\n ", + "xmlname": "tagSet" + }, + "PrivateIpAddresses": { + "shape_name": "NetworkInterfacePrivateIpAddressList", + "type": "list", + "members": { + "shape_name": "NetworkInterfacePrivateIpAddress", + "type": "structure", + "members": { + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address of the network interface.
\n ", + "xmlname": "primary" + }, + "Association": { + "shape_name": "NetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n\t", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the Elastic IP address owner.
\n ", + "xmlname": "ipOwnerId" + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe allocation ID.
\n ", + "xmlname": "allocationId" + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe association ID.
\n ", + "xmlname": "associationId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP address associated with the network interface.
\n ", + "xmlname": "association" + } + }, + "documentation": "\n\t\tDescribes the private IP address of a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more network interfaces.
\n ", + "xmlname": "networkInterfaceSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your network interfaces.
\nOne or more placement group names.
\nDefault: Describes all your placement groups, or only those otherwise specified.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\ngroup-name - The name of the placement group.
state - The state of the placement group (pending | available |\n deleting | deleted).
strategy - The strategy of the placement group (cluster).
The name of the placement group.
\n ", + "xmlname": "groupName" + }, + "Strategy": { + "shape_name": "PlacementStrategy", + "type": "string", + "enum": [ + "cluster" + ], + "documentation": "\nThe placement strategy.
\n ", + "xmlname": "strategy" + }, + "State": { + "shape_name": "PlacementGroupState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\nThe state of the placement group.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nDescribes a placement group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more placement groups.
\n ", + "xmlname": "placementGroupSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your placement groups. For more information about\n\t\t\t\tplacement groups and cluster instances, see\n\t\t\t\tCluster Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nProject in the name.The names of one or more regions.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nendpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for example, us-east-1).
The name of the region.
\n ", + "xmlname": "regionName" + }, + "Endpoint": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe region service endpoint.
\n ", + "xmlname": "regionEndpoint" + } + }, + "documentation": "\nDescribes a region.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more regions.
\n ", + "xmlname": "regionInfo" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nDescribes one or more regions that are currently available to you.
\nFor a list of the regions supported by Amazon EC2, see Regions and Endpoints.
\nOne or more Reserved Instance IDs.
\nDefault: Describes all your Reserved Instances, or only those otherwise specified.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires.
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) |\n Windows | Windows (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed.
state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The Reserved Instance offering type.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeReservedInstancesResult", + "type": "structure", + "members": { + "ReservedInstances": { + "shape_name": "ReservedInstancesList", + "type": "list", + "members": { + "shape_name": "ReservedInstances", + "type": "structure", + "members": { + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance.
\n ", + "xmlname": "reservedInstancesId" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type on which the Reserved Instance can be used.
\n ", + "xmlname": "instanceType" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n ", + "xmlname": "availabilityZone" + }, + "Start": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe date and time the Reserved Instance started.
\n ", + "xmlname": "start" + }, + "End": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time when the Reserved Instance expires.
\n ", + "xmlname": "end" + }, + "Duration": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe duration of the Reserved Instance, in seconds.
\n ", + "xmlname": "duration" + }, + "UsagePrice": { + "shape_name": "Float", + "type": "float", + "documentation": "\nThe usage price of the Reserved Instance, per hour.
\n ", + "xmlname": "usagePrice" + }, + "FixedPrice": { + "shape_name": "Float", + "type": "float", + "documentation": "\nThe purchase price of the Reserved Instance.
\n ", + "xmlname": "fixedPrice" + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of Reserved Instances purchased.
\n ", + "xmlname": "instanceCount" + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nThe Reserved Instance description.
\n ", + "xmlname": "productDescription" + }, + "State": { + "shape_name": "ReservedInstanceState", + "type": "string", + "enum": [ + "payment-pending", + "active", + "payment-failed", + "retired" + ], + "documentation": "\nThe state of the Reserved Instance purchase.
\n ", + "xmlname": "state" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "InstanceTenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the reserved instance.
\n ", + "xmlname": "instanceTenancy" + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes.\n\t\t\t\tAt this time, the only supported currency is USD.
The Reserved Instance offering type.
\n ", + "xmlname": "offeringType" + }, + "RecurringCharges": { + "shape_name": "RecurringChargesList", + "type": "list", + "members": { + "shape_name": "RecurringCharge", + "type": "structure", + "members": { + "Frequency": { + "shape_name": "RecurringChargeFrequency", + "type": "string", + "enum": [ + "Hourly" + ], + "documentation": "\nThe frequency of the recurring charge.
\n ", + "xmlname": "frequency" + }, + "Amount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe amount of the recurring charge.
\n ", + "xmlname": "amount" + } + }, + "documentation": "\nDescribes a recurring charge.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe recurring charge tag assigned to the resource.
\n ", + "xmlname": "recurringCharges" + } + }, + "documentation": "\nDescribes a Reserved Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of Reserved Instances.
\n ", + "xmlname": "reservedInstancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of the Reserved Instances that you purchased.
\nFor more information about Reserved Instances, see Reserved\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nm1.small Linux/UNIX Reserved Instances. \n If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to \n Linux/UNIX (Amazon VPC).One or more Reserved Instance IDs.
\n " + }, + "ReservedInstancesListingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nOne or more Reserved Instance Listing IDs.
\n " + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "documentation": "\nOne or more filters.
\nreserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active |\n cancelled | closed).
status-message - The reason for the status.
The ID of the Reserved Instance listing.
\n ", + "xmlname": "reservedInstancesListingId" + }, + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance.
\n ", + "xmlname": "reservedInstancesId" + }, + "CreateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the listing was created.
\n ", + "xmlname": "createDate" + }, + "UpdateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe last modified timestamp of the listing.
\n ", + "xmlname": "updateDate" + }, + "Status": { + "shape_name": "ListingStatus", + "type": "string", + "enum": [ + "active", + "pending", + "cancelled", + "closed" + ], + "documentation": "\nThe status of the Reserved Instance listing.
\n ", + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason for the current status of the Reserved Instance listing. \n\t\t\t\tThe response can be blank.
\n ", + "xmlname": "statusMessage" + }, + "InstanceCounts": { + "shape_name": "InstanceCountList", + "type": "list", + "members": { + "shape_name": "InstanceCount", + "type": "structure", + "members": { + "State": { + "shape_name": "ListingState", + "type": "string", + "enum": [ + "available", + "sold", + "cancelled", + "pending" + ], + "documentation": "\nThe states of the listed Reserved Instances.
\n ", + "xmlname": "state" + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nhe number of listed Reserved Instances in the state specified by the state.
Describes a Reserved Instance listing state.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe number of instances in this state.
\n ", + "xmlname": "instanceCounts" + }, + "PriceSchedules": { + "shape_name": "PriceScheduleList", + "type": "list", + "members": { + "shape_name": "PriceSchedule", + "type": "structure", + "members": { + "Term": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of months remaining in the reservation. For example, 2 is the second \n\t\t\t\tto the last month before the capacity reservation expires.
\n ", + "xmlname": "term" + }, + "Price": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price for the term.
\n ", + "xmlname": "price" + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency for transacting the Reserved Instance resale.\n\t\t\t\tAt this time, the only supported currency is USD.
The current price schedule, as determined by the term remaining for the \n\t\t\t\tReserved Instance in the listing.
\nA specific price schedule is always in effect, \n\t\t\t\tbut only one price schedule can be active at any time. Take, for example, a \n\t\t\t\tReserved Instance listing that has five months remaining in its term. When you \n\t\t\t\tspecify price schedules for five months and two months, this means that \n\t\t\t\tschedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. \n\t\t\t\tThen schedule 2, covering the last two months of the term, will be active for months 2 and 1.
\n ", + "xmlname": "active" + } + }, + "documentation": "\nDescribes the price for a Reserved Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe price of the Reserved Instance listing.
\n ", + "xmlname": "priceSchedules" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe idempotency token you provided when you created the listing.
\n ", + "xmlname": "clientToken" + } + }, + "documentation": "\nDescribes a Reserved Instance listing.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about the Reserved Instance listing.
\n ", + "xmlname": "reservedInstancesListingsSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes your account's Reserved Instance listings in the Reserved Instance Marketplace.
\nFor more information, see Reserved Instance Marketplace \n in the Amazon Elastic Compute Cloud User Guide.
\nIDs for the submitted modification request.
\n ", + "flattened": true + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token for the next page of data.
\n " + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nclient-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request\n (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
A unique ID for the Reserved Instance modification.
\n ", + "xmlname": "reservedInstancesModificationId" + }, + "ReservedInstancesIds": { + "shape_name": "ReservedIntancesIds", + "type": "list", + "members": { + "shape_name": "ReservedInstancesId", + "type": "structure", + "members": { + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance.
\n ", + "xmlname": "reservedInstancesId" + } + }, + "documentation": "\nDescribes the ID of a Reserved Instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe IDs of one or more Reserved Instances.
\n ", + "xmlname": "reservedInstancesSet" + }, + "ModificationResults": { + "shape_name": "ReservedInstancesModificationResultList", + "type": "list", + "members": { + "shape_name": "ReservedInstancesModificationResult", + "type": "structure", + "members": { + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
\n ", + "xmlname": "reservedInstancesId" + }, + "TargetConfiguration": { + "shape_name": "ReservedInstancesConfiguration", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone for the modified Reserved Instances.
\n ", + "xmlname": "availabilityZone" + }, + "Platform": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
\n ", + "xmlname": "platform" + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of modified Reserved Instances.
\n ", + "xmlname": "instanceCount" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type for the modified Reserved Instances.
\n ", + "xmlname": "instanceType" + } + }, + "documentation": "\nThe target Reserved Instances configurations supplied as part of the modification request.
\n ", + "xmlname": "targetConfiguration" + } + }, + "documentation": "\n ", + "xmlname": "item" + }, + "documentation": "\nContains target configurations along with their corresponding new Reserved Instance IDs.
\n ", + "xmlname": "modificationResultSet" + }, + "CreateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time when the modification request was created.
\n ", + "xmlname": "createDate" + }, + "UpdateDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time when the modification request was last updated.
\n ", + "xmlname": "updateDate" + }, + "EffectiveDate": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time for the modification to become effective.
\n ", + "xmlname": "effectiveDate" + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Reserved Instances modification request.
\n ", + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason for the status.
\n ", + "xmlname": "statusMessage" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nA unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.
\n ", + "xmlname": "clientToken" + } + }, + "documentation": "\nDescribes a Reserved Instance modification.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe Reserved Instance modification information.
\n ", + "xmlname": "reservedInstancesModificationsSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token for the next page of data.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
\nOne or more Reserved Instances offering IDs.
\n ", + "flattened": true + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type on which the Reserved Instance can be used.\n\t\t\t\tFor more information, see Instance Types \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n " + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n " + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nThe Reserved Instance description. Instances that include (Amazon VPC) \n in the description are for use with Amazon VPC.
The name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds.
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type on which the Reserved Instance can be used.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.
product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) |\n Windows | Windows (Amazon VPC)).
reserved-instances-offering-id - The Reserved Instances offering ID.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
The tenancy of the Reserved Instance offering. A Reserved Instance\n\t\t\t\twith dedicated tenancy runs on single-tenant hardware and can\n\t\t\t\tonly be launched within a VPC.
Default: default
The Reserved Instance offering type.
\n " + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token to use when requesting the next paginated set of offerings.
\n " + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of offerings to return.
\n " + }, + "IncludeMarketplace": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nInclude Marketplace offerings in the response.
\n " + }, + "MinDuration": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe minimum duration (in seconds) to filter when searching for offerings.
\n " + }, + "MaxDuration": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe maximum duration (in seconds) to filter when searching for offerings.
\n " + }, + "MaxInstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of instances to filter when searching for offerings.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeReservedInstancesOfferingsResult", + "type": "structure", + "members": { + "ReservedInstancesOfferings": { + "shape_name": "ReservedInstancesOfferingList", + "type": "list", + "members": { + "shape_name": "ReservedInstancesOffering", + "type": "structure", + "members": { + "ReservedInstancesOfferingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Reserved Instance offering.
\n ", + "xmlname": "reservedInstancesOfferingId" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type on which the Reserved Instance can be used.
\n ", + "xmlname": "instanceType" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which the Reserved Instance can be used.
\n ", + "xmlname": "availabilityZone" + }, + "Duration": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe duration of the Reserved Instance, in seconds.
\n ", + "xmlname": "duration" + }, + "UsagePrice": { + "shape_name": "Float", + "type": "float", + "documentation": "\nThe usage price of the Reserved Instance, per hour.
\n ", + "xmlname": "usagePrice" + }, + "FixedPrice": { + "shape_name": "Float", + "type": "float", + "documentation": "\nThe purchase price of the Reserved Instance.
\n ", + "xmlname": "fixedPrice" + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nThe Reserved Instance description.
\n ", + "xmlname": "productDescription" + }, + "InstanceTenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the reserved instance.
\n ", + "xmlname": "instanceTenancy" + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency of the Reserved Instance offering you are purchasing. It's \n\t\t\t\tspecified using ISO 4217 standard currency codes. At this time, \n\t\t\t\tthe only supported currency is USD.
The Reserved Instance offering type.
\n ", + "xmlname": "offeringType" + }, + "RecurringCharges": { + "shape_name": "RecurringChargesList", + "type": "list", + "members": { + "shape_name": "RecurringCharge", + "type": "structure", + "members": { + "Frequency": { + "shape_name": "RecurringChargeFrequency", + "type": "string", + "enum": [ + "Hourly" + ], + "documentation": "\nThe frequency of the recurring charge.
\n ", + "xmlname": "frequency" + }, + "Amount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe amount of the recurring charge.
\n ", + "xmlname": "amount" + } + }, + "documentation": "\nDescribes a recurring charge.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe recurring charge tag assigned to the resource.
\n ", + "xmlname": "recurringCharges" + }, + "Marketplace": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. \n If it's a Reserved Instance Marketplace offering, this is true.
The price per instance.
\n ", + "xmlname": "price" + }, + "Count": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of instances available for the price.
\n ", + "xmlname": "count" + } + }, + "documentation": "\nDescribes a Reserved Instance offering.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe pricing details of the Reserved Instance offering.
\n ", + "xmlname": "pricingDetailsSet" + } + }, + "documentation": "\nDescribes a Reserved Instance offering.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of Reserved Instances offerings.
\n ", + "xmlname": "reservedInstancesOfferingsSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe next paginated set of results to return.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes Reserved Instance offerings that are available for purchase. With \n\t\t\t\tReserved Instances, you purchase the right to launch instances for a\n\t\t\t\tperiod of time. During that time period, you do not receive insufficient capacity\n\t\t\t\terrors, and you pay a lower usage rate than the rate charged for On-Demand\n\t\t\t\tinstances for the actual time used.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nm1.small or m1.large \n Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, \n set the product description to Linux/UNIX (Amazon VPC).One or more route table IDs.
\n\t\tDefault: Describes all your route tables.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tassociation.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC.
route-table-id - The ID of the route table.
route.destination-cidr-block - The CIDR range specified in a route in the table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.origin - Describes how the route was created (CreateRouteTable | CreateRoute | EnableVgwRoutePropagation).
route.state - The state of a route in the route table (active |\n blackhole). The blackhole state indicates that the route's target isn't\n available (for example, the specified gateway isn't attached to the VPC, the specified NAT\n instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection\n specified in a route in the table.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the route table.
The ID of the route table.
\n ", + "xmlname": "routeTableId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "Routes": { + "shape_name": "RouteList", + "type": "list", + "members": { + "shape_name": "Route", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block used for the destination match.
\n ", + "xmlname": "destinationCidrBlock" + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a gateway attached to your VPC.
\n ", + "xmlname": "gatewayId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n ", + "xmlname": "instanceId" + }, + "InstanceOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe AWS account ID of the owner of the instance.
\n ", + "xmlname": "instanceOwnerId" + }, + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnectionId" + }, + "State": { + "shape_name": "RouteState", + "type": "string", + "enum": [ + "active", + "blackhole" + ], + "documentation": "\n\t\tThe state of the route. The blackhole state indicates that the\n\t\t\t\troute's target isn't available (for example, the specified gateway isn't attached to the\n\t\t\t\tVPC, or the specified NAT instance has been terminated).
Describes how the route was created.
\nCreateRouteTable indicates that route was automatically created when the route table was created.CreateRoute indicates that the route was manually added to the route table.EnableVgwRoutePropagation indicates that the route was propagated by route propagation.Describes a route in a route table.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe routes in the route table.
\n ", + "xmlname": "routeSet" + }, + "Associations": { + "shape_name": "RouteTableAssociationList", + "type": "list", + "members": { + "shape_name": "RouteTableAssociation", + "type": "structure", + "members": { + "RouteTableAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the association between a route table and a subnet.
\n ", + "xmlname": "routeTableAssociationId" + }, + "RouteTableId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the route table.
\n ", + "xmlname": "routeTableId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "Main": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the main route table.
\n ", + "xmlname": "main" + } + }, + "documentation": "\n\t\tDescribes an association between a route table and a subnet.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe associations between the route table and one or more subnets.
\n ", + "xmlname": "associationSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the route table.
\n ", + "xmlname": "tagSet" + }, + "PropagatingVgws": { + "shape_name": "PropagatingVgwList", + "type": "list", + "members": { + "shape_name": "PropagatingVgw", + "type": "structure", + "members": { + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway (VGW).
\n ", + "xmlname": "gatewayId" + } + }, + "documentation": "\n\t\tDescribes a virtual private gateway propagating route.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny virtual private gateway (VGW) propagating routes.
\n ", + "xmlname": "propagatingVgwSet" + } + }, + "documentation": "\n\t\tDescribes a route table.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more route tables.
\n ", + "xmlname": "routeTableSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your route tables.
\n\t\tFor more information about route tables, see Route Tables in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n[EC2-Classic, default VPC] One or more security group names.
\nDefault: Describes all your security groups.
\n ", + "flattened": true + }, + "GroupIds": { + "shape_name": "GroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "GroupId" + }, + "documentation": "\nOne or more security group IDs.
\nDefault: Describes all your security groups.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\ndescription - The description of the security group.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - A CIDR range that has been granted permission.
ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been granted permission.
ip-permission.group-name - The name of a security group that has been granted permission.
ip-permission.protocol - The IP protocol for the permission (tcp | udp |\n icmp or a protocol number).
ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been granted permission.
owner-id - The AWS account ID of the owner of the security group.
tag-key - The key of a tag assigned to the security group.
tag-value - The value of a tag assigned to the security group.
vpc-id - The ID of the VPC specified when the security group was created.
The AWS account ID of the owner of the security group.
\n ", + "xmlname": "ownerId" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the security group.
\n ", + "xmlname": "groupDescription" + }, + "IpPermissions": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n ", + "xmlname": "userId" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "xmlname": "groups" + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n ", + "xmlname": "cidrIp" + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "xmlname": "ipRanges" + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more inbound rules associated with the security group.
\n ", + "xmlname": "ipPermissions" + }, + "IpPermissionsEgress": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n ", + "xmlname": "userId" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "xmlname": "groups" + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n ", + "xmlname": "cidrIp" + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "xmlname": "ipRanges" + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n ", + "xmlname": "item" + }, + "documentation": "\n[EC2-VPC] One or more outbound rules associated with the security group.
\n ", + "xmlname": "ipPermissionsEgress" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The ID of the VPC for the security group.
\n ", + "xmlname": "vpcId" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the security group.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\nDescribes a security group
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more security groups.
\n ", + "xmlname": "securityGroupInfo" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your security groups.
\nA security group is for use with instances either in the EC2-Classic platform \n\t\t\t\tor in a specific VPC. For more information, see\n\t\t\t\tAmazon EC2 Security Groups in \n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide and \n\t\t\t\tSecurity Groups for Your VPC in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\napp_server_group or database_group.The ID of the Amazon EBS snapshot.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "SnapshotAttributeName", + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\nThe snapshot attribute you would like to view.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeSnapshotAttributeResult", + "type": "structure", + "members": { + "SnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Amazon EBS snapshot.
\n ", + "xmlname": "snapshotId" + }, + "CreateVolumePermissions": { + "shape_name": "CreateVolumePermissionList", + "type": "list", + "members": { + "shape_name": "CreateVolumePermission", + "type": "structure", + "members": { + "UserId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n ", + "xmlname": "userId" + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n ", + "xmlname": "group" + } + }, + "documentation": "\n ", + "xmlname": "item" + }, + "documentation": "\nA list of permissions for creating volumes from the snapshot.
\n ", + "xmlname": "createVolumePermission" + }, + "ProductCodes": { + "shape_name": "ProductCodeList", + "type": "list", + "members": { + "shape_name": "ProductCode", + "type": "structure", + "members": { + "ProductCodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of product codes.
\n ", + "xmlname": "productCodes" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the specified attribute of the specified snapshot. You can specify only one attribute at a\n time.
\nFor more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.One or more snapshot IDs.
\nDefault: Describes snapshots for which you have launch permissions.
\n ", + "flattened": true + }, + "OwnerIds": { + "shape_name": "OwnerStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Owner" + }, + "documentation": "\nReturns the snapshots owned by the specified owner. Multiple owners can be specified.
\n ", + "flattened": true + }, + "RestorableByUserIds": { + "shape_name": "RestorableByStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "RestorableBy" + }, + "documentation": "\nOne or more AWS accounts IDs that can create volumes from the snapshot.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\ndescription - A description of the snapshot.
owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
The ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "State": { + "shape_name": "SnapshotState", + "type": "string", + "enum": [ + "pending", + "completed", + "error" + ], + "documentation": "\nThe snapshot state.
\n ", + "xmlname": "status" + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the snapshot was initiated.
\n ", + "xmlname": "startTime" + }, + "Progress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe progress of the snapshot, as a percentage.
\n ", + "xmlname": "progress" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EBS snapshot owner.
\n ", + "xmlname": "ownerId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for the snapshot.
\n ", + "xmlname": "description" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\n ", + "xmlname": "volumeSize" + }, + "OwnerAlias": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account alias (for example, amazon, self) or AWS account ID\n that owns the snapshot.
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the snapshot.
\n ", + "xmlname": "tagSet" + }, + "Encrypted": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the snapshot is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nDescribes a snapshot.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "snapshotSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of the Amazon EBS snapshots available to you. Available snapshots include \n public snapshots available for any AWS account to launch, private\n snapshots that you own, and private snapshots owned by another AWS account but for which\n you've been given explicit create volume permissions.
\nThe create volume permissions fall into the following categories:
\nall group. All AWS accounts have create volume permissions for these\n snapshots.The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or\n AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all\n snapshots for which you have create volume permissions.
\nIf you specify one or more snapshot IDs, only snapshots that have the specified IDs are\n returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot\n ID for which you do not have access, it is not included in the returned results.
\nIf you specify one or more snapshot owners, only snapshots from the specified owners and for\n which you have access are returned. The results can include the AWS account IDs of the specified\n owners, amazon for snapshots owned by Amazon, or self for snapshots\n that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for\n those users are returned. You can specify AWS account IDs (if you own the snapshots),\n self for snapshots for which you own or have explicit permissions, or\n all for public snapshots.
For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d.pending status, and that are also tagged with a value that includes the string\n db_.The AWS account ID of the account.
\n ", + "xmlname": "ownerId" + }, + "Bucket": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon S3 bucket where the Spot Instance datafeed is located.
\n ", + "xmlname": "bucket" + }, + "Prefix": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe prefix that is prepended to datafeed files.
\n ", + "xmlname": "prefix" + }, + "State": { + "shape_name": "DatafeedSubscriptionState", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "documentation": "\nThe state of the Spot Instance datafeed subscription.
\n ", + "xmlname": "state" + }, + "Fault": { + "shape_name": "SpotInstanceStateFault", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the Spot Instance state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the Spot Instance state change.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", + "xmlname": "fault" + } + }, + "documentation": "\nThe Spot Instance datafeed subscription.
\n ", + "xmlname": "spotDatafeedSubscription" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the datafeed for Spot Instances. For more information, see\n\t\t\t\tSpot Instances in\n\t\t\t\tthe Amazon Elastic Compute Cloud User Guide.
\nOne or more Spot Instance request IDs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\navailability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of the Amazon EBS volume\n (gp2 | standard | io1).
launch.group-id - The security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m1.small).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launch.network-interface.network-interface-id - The ID of the network interface.
launch.network-interface.device-index - The index of the device for the network interface attachment on the instance.
launch.network-interface.subnet-id - The ID of the subnet for the instance.
launch.network-interface.description - A description of the network interface.
launch.network-interface.private-ip-address - The primary private IP address of the network interface.
launch.network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
launch.network-interface.group-id - The ID of the security group associated with the network interface.
launch.network-interface.group-name - The name of the security group associated with the network interface.
launch.network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed |\n cancelled | failed).
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of Spot Instance request (one-time | persistent).
launched-availability-zone - The Availability Zone in which the bid is launched.
valid-from - The start date of the request.
valid-until - The end date of the request.
The ID of the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestId" + }, + "SpotPrice": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", + "xmlname": "spotPrice" + }, + "Type": { + "shape_name": "SpotInstanceType", + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\nThe Spot Instance request type.
\n ", + "xmlname": "type" + }, + "State": { + "shape_name": "SpotInstanceState", + "type": "string", + "enum": [ + "open", + "active", + "closed", + "cancelled", + "failed" + ], + "documentation": "\nThe state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
\n ", + "xmlname": "state" + }, + "Fault": { + "shape_name": "SpotInstanceStateFault", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the Spot Instance state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the Spot Instance state change.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", + "xmlname": "fault" + }, + "Status": { + "shape_name": "SpotInstanceStatus", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status code of the request.
\n ", + "xmlname": "code" + }, + "UpdateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time of the most recent status update.
\n ", + "xmlname": "updateTime" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for the status code for the Spot request.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe status code and status message describing the Spot Instance request.
\n ", + "xmlname": "status" + }, + "ValidFrom": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.
\n ", + "xmlname": "validFrom" + }, + "ValidUntil": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.
\n ", + "xmlname": "validUntil" + }, + "LaunchGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.
\n ", + "xmlname": "launchGroup" + }, + "AvailabilityZoneGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.
\n ", + "xmlname": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "shape_name": "LaunchSpecification", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI.
\n ", + "xmlname": "imageId" + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair.
\n ", + "xmlname": "keyName" + }, + "SecurityGroups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "UserData": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n ", + "xmlname": "userData" + }, + "AddressingType": { + "shape_name": "String", + "type": "string", + "documentation": "\n \n ", + "xmlname": "addressingType" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "Placement": { + "shape_name": "SpotPlacement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone.
\n ", + "xmlname": "availabilityZone" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone group name.
\n ", + "xmlname": "groupName" + } + }, + "documentation": "\nThe placement information for the instance.
\n ", + "xmlname": "placement" + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the kernel.
\n ", + "xmlname": "kernelId" + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the RAM disk.
\n ", + "xmlname": "ramdiskId" + }, + "BlockDeviceMappings": { + "shape_name": "BlockDeviceMappingList", + "type": "list", + "members": { + "shape_name": "BlockDeviceMapping", + "type": "structure", + "members": { + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n ", + "xmlname": "virtualName" + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", + "xmlname": "volumeSize" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", + "xmlname": "noDevice" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more block device mapping entries.
\n ", + "xmlname": "blockDeviceMapping" + }, + "MonitoringEnabled": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n ", + "xmlname": "monitoringEnabled" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\n ", + "xmlname": "subnetId" + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceSpecificationList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterfaceSpecification", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", + "xmlname": "deviceIndex" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n ", + "xmlname": "subnetId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description of the network interface.
\n ", + "xmlname": "description" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n ", + "xmlname": "privateIpAddress" + }, + "Groups": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", + "xmlname": "SecurityGroupId" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", + "required": true, + "xmlname": "privateIpAddress" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n ", + "xmlname": "primary" + } + }, + "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of secondary private IP addresses.
\n ", + "xmlname": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.
\n ", + "xmlname": "associatePublicIpAddress" + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more network interfaces.
\n ", + "xmlname": "networkInterfaceSet" + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfileSpecification", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", + "xmlname": "arn" + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the instance profile.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe IAM instance profile.
\n ", + "xmlname": "iamInstanceProfile" + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.
\nDefault: false
Additional information for launching instances.
\n ", + "xmlname": "launchSpecification" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.
\n ", + "xmlname": "instanceId" + }, + "CreateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the Spot Instance request was created.
\n ", + "xmlname": "createTime" + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nThe product description associated with the Spot Instance.
\n ", + "xmlname": "productDescription" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "LaunchedAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which the bid is launched.
\n ", + "xmlname": "launchedAvailabilityZone" + } + }, + "documentation": "\nDescribe a Spot Instance request.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more Spot Instance requests.
\n ", + "xmlname": "spotInstanceRequestSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the Spot Instance requests that belong to your account. Spot Instances\n\t\t\t\tare instances that Amazon EC2 starts on your behalf when the maximum price that you\n\t\t\t\tspecify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price\n\t\t\t\tbased on available Spot Instance capacity and current Spot Instance requests. For\n\t\t\t\tmore information about Spot Instances, see \n\t\t\t\tSpot Instances in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
\nYou can use DescribeSpotInstanceRequests to find a\n\t\t\t\trunning Spot Instance by examining the response. If the status of\n\t\t\t\tthe Spot Instance is fulfilled, the instance ID \n\t\t\t\tappears in the response and contains the identifier of the instance.\n\t\t\t\tAlternatively, you can use DescribeInstances with a filter to\n\t\t\t\tlook for instances where the instance lifecycle is spot.
fulfilled\n The start date and time of the Spot Price history data.
\n " + }, + "EndTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe end date and time of the Spot Price history data.
\n " + }, + "InstanceTypes": { + "shape_name": "InstanceTypeList", + "type": "list", + "members": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": null, + "xmlname": "InstanceType" + }, + "documentation": "\nOne or more instance types.
\n ", + "flattened": true + }, + "ProductDescriptions": { + "shape_name": "ProductDescriptionList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ProductDescription" + }, + "documentation": "\nOne or more basic product descriptions.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\navailability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m1.small).
product-description - The product description for the Spot Price\n (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). \n You can use wildcards (* and ?). Greater than or less than comparison is not supported.
The Availability Zone.
\n " + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of rows to return.
\n " + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe next set of rows to return.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeSpotPriceHistoryResult", + "type": "structure", + "members": { + "SpotPriceHistory": { + "shape_name": "SpotPriceHistoryList", + "type": "list", + "members": { + "shape_name": "SpotPrice", + "type": "structure", + "members": { + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nA general description of the AMI.
\n ", + "xmlname": "productDescription" + }, + "SpotPrice": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe maximum price you will pay to launch one or more Spot Instances.
\n ", + "xmlname": "spotPrice" + }, + "Timestamp": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe date and time the request was created.
\n ", + "xmlname": "timestamp" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone.
\n ", + "xmlname": "availabilityZone" + } + }, + "documentation": "\nDescribes the Spot Price.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe historical Spot Prices.
\n ", + "xmlname": "spotPriceHistorySet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe string marking the next set of results. This is empty\n\t\t\t\tif there are no more results.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the Spot Price history. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nWhen you specify an Availability Zone, this operation describes the price history \n for the specified Availability Zone with the most recent set of prices listed first. \n If you don't specify an Availability Zone, you get the prices across all Availability Zones, \n starting with the most recent set. However, if you're using an API version earlier than 2011-05-15,\n you get the lowest price across the region for the specified time period. The prices \n returned are listed in chronological order, from the oldest to the most recent.
\nOne or more subnet IDs.
\n\t\tDefault: Describes all your subnets.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tavailabilityZone - The Availability Zone for the subnet. You can also use\n\t\t\t\t\t\tavailability-zone as the filter name.
available-ip-address-count - The number of IP addresses in the subnet that are available.
cidrBlock - The CIDR block of the subnet. The CIDR block you specify must\n\t\t\t\t\texactly match the subnet's CIDR block for information to be returned for the subnet. You\n\t\t\t\t\tcan also use cidr or cidr-block as the filter names.
defaultForAz - Indicates whether this is the default subnet for the\n\t\t\t\t\tAvailability Zone. You can also use default-for-az as the filter name.
state - The state of the subnet (pending | available).
subnet-id - The ID of the subnet.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC for the subnet.
The ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "State": { + "shape_name": "SubnetState", + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\tThe current state of the subnet.
\n ", + "xmlname": "state" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC the subnet is in.
\n ", + "xmlname": "vpcId" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block assigned to the subnet.
\n ", + "xmlname": "cidrBlock" + }, + "AvailableIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of unused IP addresses in the subnet. Note that the IP addresses for any\n\t\t\t\tstopped instances are considered unavailable.
\n ", + "xmlname": "availableIpAddressCount" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone of the subnet.
\n ", + "xmlname": "availabilityZone" + }, + "DefaultForAz": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this is the default subnet for the Availability Zone.
\n ", + "xmlname": "defaultForAz" + }, + "MapPublicIpOnLaunch": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether instances launched in this subnet receive a public IP address.
\n ", + "xmlname": "mapPublicIpOnLaunch" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the subnet.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes a subnet.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more subnets.
\n ", + "xmlname": "subnetSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your subnets.
\n\t\tFor more information about subnets, see Your VPC and Subnets\n\t\t\t in the Amazon Virtual Private Cloud User Guide.
\nsubnet-9d4a7b6c and\n\t\t\t\t\tsubnet-6e7f829e.vpc-1a2b3c4d or vpc-6e7f8a92, and whose state is\n\t\t\t\t\tavailable.The name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nkey - The tag key.
resource-id - The resource ID.
resource-type - The resource type \n (customer-gateway |\n dhcp-options |\n image |\n instance |\n internet-gateway | \n network-acl | \n network-interface | \n reserved-instances | \n route-table | \n security-group | \n snapshot | spot-instances-request | \n subnet |\n volume | vpc |\n vpn-connection |\n vpn-gateway).
value - The tag value.
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. If the value is greater than 1000, we return only 1000 items.
\n " + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token for the next set of items to return. (You received this token from a prior call.)
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeTagsResult", + "type": "structure", + "members": { + "Tags": { + "shape_name": "TagDescriptionList", + "type": "list", + "members": { + "shape_name": "TagDescription", + "type": "structure", + "members": { + "ResourceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the resource. For example, ami-1a2b3c4d.
The type of resource.
\n ", + "xmlname": "resourceType" + }, + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\n ", + "xmlname": "key" + }, + "Value": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value of the tag.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of tags.
\n ", + "xmlname": "tagSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of the tags for your EC2 resources.
\nFor more information about tags, see Tagging Your Resources in the\n Amazon Elastic Compute Cloud User Guide.
\n?ebserver to\n find tags with the key webserver or\n Webserver.The ID of the volume.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "VolumeAttributeName", + "type": "string", + "enum": [ + "autoEnableIO", + "productCodes" + ], + "documentation": "\nThe instance attribute.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeVolumeAttributeResult", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "AutoEnableIO": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\nThe state of autoEnableIO attribute.
The product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of product codes.
\n ", + "xmlname": "productCodes" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the specified attribute of the specified volume. You can specify only one attribute\n at a time.
\nFor more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
\nautoEnableIO attribute of the volume\n vol-12345678.productCodes attribute of the volume\n vol-12345678.One or more volume IDs.
\nDefault: Describes all your volumes.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\naction.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed;\n for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed;\n for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The next paginated set of results to return using the pagination token\n returned by a previous call.
\n " + }, + "MaxResults": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of paginated volume items per response.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeVolumeStatusResult", + "type": "structure", + "members": { + "VolumeStatuses": { + "shape_name": "VolumeStatusList", + "type": "list", + "members": { + "shape_name": "VolumeStatusItem", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume ID.
\n ", + "xmlname": "volumeId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone of the volume.
\n ", + "xmlname": "availabilityZone" + }, + "VolumeStatus": { + "shape_name": "VolumeStatusInfo", + "type": "structure", + "members": { + "Status": { + "shape_name": "VolumeStatusInfoStatus", + "type": "string", + "enum": [ + "ok", + "impaired", + "insufficient-data" + ], + "documentation": "\nThe status of the volume.
\n ", + "xmlname": "status" + }, + "Details": { + "shape_name": "VolumeStatusDetailsList", + "type": "list", + "members": { + "shape_name": "VolumeStatusDetails", + "type": "structure", + "members": { + "Name": { + "shape_name": "VolumeStatusName", + "type": "string", + "enum": [ + "io-enabled", + "io-performance" + ], + "documentation": "\nThe name of the volume status.
\n ", + "xmlname": "name" + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe intended status of the volume status.
\n ", + "xmlname": "status" + } + }, + "documentation": "\nDescribes a volume status.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe details of the volume status.
\n ", + "xmlname": "details" + } + }, + "documentation": "\nThe volume status.
\n ", + "xmlname": "volumeStatus" + }, + "Events": { + "shape_name": "VolumeStatusEventsList", + "type": "list", + "members": { + "shape_name": "VolumeStatusEvent", + "type": "structure", + "members": { + "EventType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe type of this event.
\n ", + "xmlname": "eventType" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the event.
\n ", + "xmlname": "description" + }, + "NotBefore": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe earliest start time of the event.
\n ", + "xmlname": "notBefore" + }, + "NotAfter": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe latest end time of the event.
\n ", + "xmlname": "notAfter" + }, + "EventId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of this event.
\n ", + "xmlname": "eventId" + } + }, + "documentation": "\nDescribes a volume status event.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of events associated with the volume.
\n ", + "xmlname": "eventsSet" + }, + "Actions": { + "shape_name": "VolumeStatusActionsList", + "type": "list", + "members": { + "shape_name": "VolumeStatusAction", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe code identifying the operation, for example, enable-volume-io.
A description of the operation.
\n ", + "xmlname": "description" + }, + "EventType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe event type associated with this operation.
\n ", + "xmlname": "eventType" + }, + "EventId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the event associated with this operation.
\n ", + "xmlname": "eventId" + } + }, + "documentation": "\nDescribes a volume status operation code.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe details of the operation.
\n ", + "xmlname": "actionsSet" + } + }, + "documentation": "\nDescribes the volume status.
\n ", + "xmlname": "item" + }, + "documentation": "\nA list of volumes.
\n ", + "xmlname": "volumeStatusSet" + }, + "NextToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe next paginated set of results to return.
\n ", + "xmlname": "nextToken" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the status of the specified volumes. Volume status provides the result of the\n checks performed on your volumes to determine events that can impair the performance of your\n volumes. The performance of a volume can be affected if an issue occurs on the volume's\n underlying host. If the volume's underlying host experiences a power outage or system issue,\n after the system is restored, there could be data inconsistencies on the volume. Volume events\n notify you if this occurs. Volume actions notify you if any action needs to be taken in\n response to the event.
\nThe DescribeVolumeStatus operation provides the following information about the\n specified volumes:
Status: Reflects the current status of the volume. The possible values are\n ok, impaired , warning, or\n insufficient-data. If all checks pass, the overall status of the volume is\n ok. If the check fails, the overall status is impaired. If the\n status is insufficient-data, then the checks may still be taking place on your\n volume at the time. We recommend that you retry the request. For more information on volume status,\n see Monitoring the Status of Your\n Volumes.
Events: Reflect the cause of a volume status and may require you to take action.\n For example, if your volume returns an impaired status, then the volume event\n might be potential-data-inconsistency. This means that your volume has been\n affected by an issue with the underlying host, has all I/O operations disabled, and may have\n inconsistent data.
Actions: Reflect the actions you may have to take in response to an event. For\n example, if the status of the volume is impaired and the volume event shows\n potential-data-inconsistency, then the action shows\n enable-volume-io. This means that you may want to enable the I/O operations for\n the volume by calling the EnableVolumeIO action and then check the volume for data\n consistency.
Volume status is based on the volume status checks, and does not reflect the volume state.\n Therefore, volume status does not indicate volumes in the error state (for\n example, when a volume is incapable of accepting I/O.)
enable-volume-io\n us-east-1d\n Availability Zone with failed\n io-enabled status.One or more volume IDs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\nattachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching | detached).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume (creating | available | in-use | deleting | deleted | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This can be gp2 for\n General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for\n Magnetic volumes.
The ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "Size": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiBs.
\n ", + "xmlname": "size" + }, + "SnapshotId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe snapshot from which the volume was created, if applicable.
\n ", + "xmlname": "snapshotId" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone for the volume.
\n ", + "xmlname": "availabilityZone" + }, + "State": { + "shape_name": "VolumeState", + "type": "string", + "enum": [ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ], + "documentation": "\nThe volume state.
\n ", + "xmlname": "status" + }, + "CreateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when volume creation was initiated.
\n ", + "xmlname": "createTime" + }, + "Attachments": { + "shape_name": "VolumeAttachmentList", + "type": "list", + "members": { + "shape_name": "VolumeAttachment", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name.
\n ", + "xmlname": "device" + }, + "State": { + "shape_name": "VolumeAttachmentState", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state of the volume.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\nDescribes volume attachment details.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "attachmentSet" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the volume.
\n ", + "xmlname": "tagSet" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for\n Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.
The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD)\n volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD)\n volumes, this represents the baseline performance of the volume and the rate at which the\n volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline\n performance, I/O credits, and bursting, see Amazon EBS\n Volume Types in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nDescribes a volume.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "volumeSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes the specified Amazon EBS volumes.
\nFor more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the VPC.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "VpcAttributeName", + "type": "string", + "enum": [ + "enableDnsSupport", + "enableDnsHostnames" + ], + "documentation": "\n\t\tThe VPC attribute.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "DescribeVpcAttributeResult", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "EnableDnsSupport": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n ", + "xmlname": "value" + } + }, + "documentation": "\n\t\tIndicates whether DNS resolution is enabled for\n\t\t\t\tthe VPC. If this attribute is true, the Amazon DNS server\n\t\t\t\tresolves DNS hostnames for your instances to their corresponding\n\t\t\t\tIP addresses; otherwise, it does not.
Indicates whether the instances launched in the VPC get DNS hostnames.\n\t\t\t\tIf this attribute is true, instances in the VPC get DNS hostnames;\n\t\t\t\totherwise, they do not.
Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
\nenableDnsSupport attribute of the specified VPC.\n The sample response indicates that DNS resolution is supported.enableDnsHostnames attribute of the\n\t\t\t\t\tspecified VPC. The sample response indicates that DNS hostnames are supported.One or more VPC peering connection IDs.
\nDefault: Describes all your VPC peering connections.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\nOne or more filters.
\naccepter-vpc-info.cidr-block - The CIDR block of the peer VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer\n VPC.
accepter-vpc-info.vpc-id - The ID of the peer VPC.
expiration-time - The expiration date and time for the VPC peering\n connection.
requester-vpc-info.cidr-block - The CIDR block of the requester's\n VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of the\n requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection\n (pending-acceptance | failed | expired |\n provisioning | active | deleted |\n rejected).
status-message - A message that provides more information about the status\n of the VPC peering connection, if applicable.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-peering-connection-id - The ID of the VPC peering connection.
The CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the peer VPC.
\n ", + "xmlname": "accepterVpcInfo" + }, + "ExpirationTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time that an unaccepted VPC peering connection will expire.
\n ", + "xmlname": "expirationTime" + }, + "RequesterVpcInfo": { + "shape_name": "VpcPeeringConnectionVpcInfo", + "type": "structure", + "members": { + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the VPC owner.
\n ", + "xmlname": "ownerId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC.
\n ", + "xmlname": "vpcId" + } + }, + "documentation": "\nThe information of the requester VPC.
\n ", + "xmlname": "requesterVpcInfo" + }, + "Status": { + "shape_name": "VpcPeeringConnectionStateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nA message that provides more information about the status, if applicable.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe status of the VPC peering connection.
\n ", + "xmlname": "status" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC peering connection.
\n ", + "xmlname": "vpcPeeringConnectionId" + } + }, + "documentation": "\nDescribes a VPC peering connection.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about the VPC peering connections
\n ", + "xmlname": "vpcPeeringConnectionSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nDescribes one or more of your VPC peering connections.
\npending-acceptance state.Name=Finance or Name=Accounts.vpc-1a2b3c4d.One or more VPC IDs.
\n\t\tDefault: Describes all your VPCs.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tcidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC.
dhcp-options-id - The ID of a set of DHCP options.
isDefault - Indicates whether the VPC is the default VPC.
state - The state of the VPC (pending | available).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
vpc-id - The ID of the VPC.
The ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "VpcState", + "type": "string", + "enum": [ + "pending", + "available" + ], + "documentation": "\n\t\tThe current state of the VPC.
\n ", + "xmlname": "state" + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block for the VPC.
\n ", + "xmlname": "cidrBlock" + }, + "DhcpOptionsId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the set of DHCP options you've associated with the VPC (or default\n\t\t\t\tif the default options are associated with the VPC).
The key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the VPC.
\n ", + "xmlname": "tagSet" + }, + "InstanceTenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\n\t\tThe allowed tenancy of instances launched into the VPC.
\n ", + "xmlname": "instanceTenancy" + }, + "IsDefault": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the VPC is the default VPC.
\n ", + "xmlname": "isDefault" + } + }, + "documentation": "\n\t\tDescribes a VPC.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more VPCs.
\n ", + "xmlname": "vpcSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your VPCs.
\ndopt-7a8b9c2d or \n\t\t\t\t\tdopt-2b2a3d3c and whose state is available.One or more VPN connection IDs.
\n\t\tDefault: Describes your VPN connections.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tcustomer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
The ID of the VPN connection.
\n ", + "xmlname": "vpnConnectionId" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the VPN connection.
\n ", + "xmlname": "state" + }, + "CustomerGatewayConfiguration": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe configuration information for the VPN connection's customer gateway (in the\n\t\t\t\tnative XML format). This element is always present in the\n\t\t\t\tCreateVpnConnection response; however, it's present in the\n\t\t\t\tDescribeVpnConnections response only if the VPN connection is in\n\t\t\t\tthe pending or available state.
The type of VPN connection.
\n ", + "xmlname": "type" + }, + "CustomerGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the customer gateway at your end of the VPN connection.
\n ", + "xmlname": "customerGatewayId" + }, + "VpnGatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway at the AWS side of the VPN connection.
\n ", + "xmlname": "vpnGatewayId" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the VPN connection.
\n ", + "xmlname": "tagSet" + }, + "VgwTelemetry": { + "shape_name": "VgwTelemetryList", + "type": "list", + "members": { + "shape_name": "VgwTelemetry", + "type": "structure", + "members": { + "OutsideIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Internet-routable IP address of the virtual private gateway's outside interface.
\n ", + "xmlname": "outsideIpAddress" + }, + "Status": { + "shape_name": "TelemetryStatus", + "type": "string", + "enum": [ + "UP", + "DOWN" + ], + "documentation": "\n\t\tThe status of the VPN tunnel.
\n ", + "xmlname": "status" + }, + "LastStatusChange": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe date and time of the last change in status.
\n ", + "xmlname": "lastStatusChange" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tIf an error occurs, a description of the error.
\n ", + "xmlname": "statusMessage" + }, + "AcceptedRouteCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of accepted routes.
\n ", + "xmlname": "acceptedRouteCount" + } + }, + "documentation": "\n\t\tDescribes telemetry for a VPN tunnel.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about the VPN tunnel.
\n ", + "xmlname": "vgwTelemetry" + }, + "Options": { + "shape_name": "VpnConnectionOptions", + "type": "structure", + "members": { + "StaticRoutesOnly": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the VPN connection uses static routes only. \n\t\t Static routes must be used for devices that don't support BGP.
\n ", + "xmlname": "staticRoutesOnly" + } + }, + "documentation": "\n\t\tThe VPN connection options.
\n ", + "xmlname": "options" + }, + "Routes": { + "shape_name": "VpnStaticRouteList", + "type": "list", + "members": { + "shape_name": "VpnStaticRoute", + "type": "structure", + "members": { + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR block associated with the local subnet of the customer data center.
\n ", + "xmlname": "destinationCidrBlock" + }, + "Source": { + "shape_name": "VpnStaticRouteSource", + "type": "string", + "enum": [ + "Static" + ], + "documentation": "\n\t\tIndicates how the routes were provided.
\n ", + "xmlname": "source" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the static route.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes a static route for a VPN connection.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe static routes associated with the VPN connection.
\n ", + "xmlname": "routes" + } + }, + "documentation": "\n\t\tDescribes a VPN connection.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more VPN connections.
\n ", + "xmlname": "vpnConnectionSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your VPN connections.
\n\t\tFor more information about VPN connections, see Adding a Hardware Virtual Private Gateway\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\npending or available.One or more virtual private gateway IDs.
\n\t\tDefault: Describes all your virtual private gateways.
\n ", + "flattened": true + }, + "Filters": { + "shape_name": "FilterList", + "type": "list", + "members": { + "shape_name": "Filter", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the filter.
\n " + }, + "Values": { + "shape_name": "ValueStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "Value" + }, + "documentation": "\nOne or more filter values.
\n ", + "flattened": true + } + }, + "documentation": "\n ", + "xmlname": "Filter" + }, + "documentation": "\n\t\tOne or more filters.
\n\t\tattachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway.
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:key=value - The key/value combination of a tag assigned to the resource.
tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. \n\t\t For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both \n\t\t the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). \n\t\t If you want to list only resources where Purpose is X, see the tag:key=value filter.
tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
The ID of the virtual private gateway.
\n ", + "xmlname": "vpnGatewayId" + }, + "State": { + "shape_name": "VpnState", + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ], + "documentation": "\n\t\tThe current state of the virtual private gateway.
\n ", + "xmlname": "state" + }, + "Type": { + "shape_name": "GatewayType", + "type": "string", + "enum": [ + "ipsec.1" + ], + "documentation": "\n\t\tThe type of VPN connection the virtual private gateway supports.
\n ", + "xmlname": "type" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe Availability Zone where the virtual private gateway was created.
\n ", + "xmlname": "availabilityZone" + }, + "VpcAttachments": { + "shape_name": "VpcAttachmentList", + "type": "list", + "members": { + "shape_name": "VpcAttachment", + "type": "structure", + "members": { + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "State": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe current state of the attachment.
\n ", + "xmlname": "state" + } + }, + "documentation": "\n\t\tDescribes an attachment between a virtual private gateway and a VPC.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny VPCs attached to the virtual private gateway.
\n ", + "xmlname": "attachments" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tAny tags assigned to the virtual private gateway.
\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n\t\tDescribes a virtual private gateway.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tInformation about one or more virtual private gateways.
\n ", + "xmlname": "vpnGatewaySet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tDescribes one or more of your virtual private gateways.
\n\t\tFor more information about virtual private gateways, see Adding an IPsec Hardware VPN\n\t\t\t\tto Your VPC in the Amazon Virtual Private Cloud User Guide.
\npending or available.The ID of the Internet gateway.
\n ", + "required": true + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDetaches an Internet gateway from a VPC, disabling connectivity between the\n\t\t\t\tInternet and the VPC. The VPC must not contain any running instances with Elastic IP\n\t\t\t\taddresses.
\nThe ID of the attachment.
\n ", + "required": true + }, + "Force": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tSpecifies whether to force a detachment.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDetaches a network interface from an instance.
\nThe ID of the volume.
\n ", + "required": true + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n " + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name.
\n " + }, + "Force": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nForces detachment if the previous detachment attempt did not occur cleanly (for example,\n logging into an instance, unmounting the volume, and detaching normally). This option can lead\n to data loss or a corrupted file system. Use this option only as a last resort to detach a\n volume from a failed instance. The instance won't have an opportunity to flush file system\n caches or file system metadata. If you use this option, you must perform file system check and\n repair procedures.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "VolumeAttachment", + "type": "structure", + "members": { + "VolumeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the volume.
\n ", + "xmlname": "volumeId" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Device": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name.
\n ", + "xmlname": "device" + }, + "State": { + "shape_name": "VolumeAttachmentState", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state of the volume.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n ", + "xmlname": "attachment" + }, + "errors": [], + "documentation": "\nDetaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the\n device within your operating system before detaching the volume. Failure to do so results in\n the volume being stuck in a busy state while detaching.
\nIf an Amazon EBS volume is the root device of an instance, it can't be detached while the\n instance is running. To detach the root volume, stop the instance\n first.
\nIf the root volume is detached from an instance with an AWS Marketplace product code, then\n the AWS Marketplace product codes from that volume are no longer associated with the\n instance.
\nFor more information, see Detaching an\n Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
\nvol-1a2b3c4d.The ID of the virtual private gateway.
\n ", + "required": true + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDetaches a virtual private gateway from a VPC. You do this if you're planning to turn off the\n\t\t\t\tVPC and not use it anymore. You can confirm a virtual private gateway has been completely\n\t\t\t\tdetached from a VPC by describing the virtual private gateway (any attachments to the\n\t\t\t\tvirtual private gateway are also described).
\n\t\tYou must wait for the attachment's state to switch to detached before\n\t\t\t\tyou can delete the VPC or attach a different VPC to the virtual private gateway.
The ID of the routing table.
\n ", + "required": true + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDisables a virtual private gateway (VGW) from propagating routes to the routing\n\t\t\t\ttables of a VPC.
\nvgw-d8e09e8a\n\t\t\t\t\tfrom automatically propagating routes to the routing table with ID\n\t\t\t\t\trtb-c98a35a0.[EC2-Classic] The Elastic IP address.
\n " + }, + "AssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The association ID.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nDisassociates an Elastic IP address from the instance or network interface it's\n\t\t\t\tassociated with.
\nThis is an idempotent operation. If you perform the operation more than once, Amazon EC2\n\t\t\t\tdoesn't return an error.
\nThe association ID representing the current association between the route table and subnet.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tDisassociates a subnet from a route table.
\n\t\tAfter you perform this action, the subnet no longer uses the routes in the route table.\n\t\t\t\tInstead, it uses the routes in the VPC's main route table. For more information\n\t\t\t\tabout route tables, see Route\n\t\t\t\tTables in the Amazon Virtual Private Cloud User Guide.
\nThe ID of the routing table.
\n ", + "required": true + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the virtual private gateway.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tEnables a virtual private gateway (VGW) to propagate routes to the routing tables\n\t\t\t\tof a VPC.
\nrtb-c98a35a0.The ID of the volume.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nEnables I/O operations for a volume that had I/O operations disabled because the data on the\n volume was potentially inconsistent.
\nThe ID of the instance.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "GetConsoleOutputResult", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Timestamp": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the output was last updated.
\n ", + "xmlname": "timestamp" + }, + "Output": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe console output, Base64 encoded.
\n ", + "xmlname": "output" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nGets the console output for the specified instance.
\nInstances do not have a physical monitor through which you can view their\n console output. They also lack physical controls that allow you to power up, reboot,\n or shut them down. To allow these actions, we provide them through the Amazon EC2\n API and command line interface.
\n\t\t\tInstance console output is buffered and posted shortly after instance boot,\n\t\t\t\treboot, and termination. Amazon EC2 preserves the most recent 64 KB output which\n\t\t\t\tis available for at least one hour after the most recent post.
\n\t\t\tFor Linux/Unix instances, the instance console output displays the\n\t\t\t\texact console output that would normally be displayed on a physical monitor attached\n\t\t\t\tto a machine. This output is buffered because the instance produces it and then\n\t\t\t\tposts it to a store where the instance's owner can retrieve it.
\n\t\t\tFor Windows instances, the instance console output displays the last\n\t\t\t\tthree system event log errors.
\nThe ID of the Windows instance.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "GetPasswordDataResult", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Windows instance.
\n ", + "xmlname": "instanceId" + }, + "Timestamp": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the data was last updated.
\n ", + "xmlname": "timestamp" + }, + "PasswordData": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe password of the instance.
\n ", + "xmlname": "passwordData" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\t\tRetrieves the encrypted administrator password for an instance running\n\t\t\t\tWindows.
\n\t\t\tThe Windows password is only generated the first time an AMI is launched.\n\t\t\t\tIt is not generated for rebundled AMIs or after the password is changed on an\n\t\t\t\tinstance.
\n\t\t\tThe password is encrypted using the key pair that you specified when you launched the instance.\n\t\t\t\tYou must provide the corresponding key pair file.
\n\t\t\tPassword generation and encryption takes a few moments. We recommend that you wait up to\n\t\t\t\t15 minutes after launching an instance before trying to retrieve the generated\n\t\t\t\tpassword.
\nA description for the instance being imported.
\n " + }, + "LaunchSpecification": { + "shape_name": "ImportInstanceLaunchSpecification", + "type": "structure", + "members": { + "Architecture": { + "shape_name": "ArchitectureValues", + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\nThe architecture of the instance.
\n " + }, + "GroupNames": { + "shape_name": "SecurityGroupStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "GroupName" + }, + "documentation": "\nOne or more security group names.
\n ", + "flattened": true + }, + "AdditionalInfo": { + "shape_name": "String", + "type": "string", + "documentation": "\n " + }, + "UserData": { + "shape_name": "String", + "type": "string", + "documentation": "\nUser data to be made available to the instance.
\n " + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
\n " + }, + "Placement": { + "shape_name": "Placement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone of the instance.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n " + }, + "Tenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
[EC2-VPC] The ID of the subnet to launch the instance\n into.
\n " + }, + "InstanceInitiatedShutdownBehavior": { + "shape_name": "ShutdownBehavior", + "type": "string", + "enum": [ + "stop", + "terminate" + ], + "documentation": "\nIndicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).
\n " + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] Optionally, you can use this parameter to assign the\n instance a specific available IP address from the IP address range of\n the subnet.
\n " + } + }, + "documentation": "\n \n " + }, + "DiskImages": { + "shape_name": "DiskImageList", + "type": "list", + "members": { + "shape_name": "DiskImage", + "type": "structure", + "members": { + "Image": { + "shape_name": "DiskImageDetail", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true + }, + "Bytes": { + "shape_name": "Long", + "type": "long", + "documentation": "\n ", + "required": true + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "no_paramfile": true + } + }, + "documentation": "\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n " + }, + "Volume": { + "shape_name": "VolumeDetail", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume, in GiB.
\n ", + "required": true + } + }, + "documentation": "\n " + } + }, + "documentation": "\nDescribes a disk image.
\n ", + "xmlname": "DiskImage" + }, + "documentation": "\n ", + "flattened": true + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe instance operating system.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ImportInstanceResult", + "type": "structure", + "members": { + "ConversionTask": { + "shape_name": "ConversionTask", + "type": "structure", + "members": { + "ConversionTaskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the conversion task.
\n ", + "required": true, + "xmlname": "conversionTaskId" + }, + "ExpirationTime": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\n ", + "xmlname": "expirationTime" + }, + "ImportInstance": { + "shape_name": "ImportInstanceTaskDetails", + "type": "structure", + "members": { + "Volumes": { + "shape_name": "ImportInstanceVolumeDetailSet", + "type": "list", + "members": { + "shape_name": "ImportInstanceVolumeDetailItem", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the import of this particular disk image.
\n ", + "required": true, + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status information or errors related to the disk image.
\n ", + "xmlname": "statusMessage" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nDescribes an import volume task.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "required": true, + "xmlname": "volumes" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "instanceId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe instance operating system.
\n ", + "xmlname": "platform" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", + "xmlname": "importInstance" + }, + "ImportVolume": { + "shape_name": "ImportVolumeTaskDetails", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description you provided when starting the import volume task.
\n ", + "xmlname": "description" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + } + }, + "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", + "xmlname": "importVolume" + }, + "State": { + "shape_name": "ConversionTaskState", + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the conversion task.
\n ", + "required": true, + "xmlname": "state" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status message related to the conversion task.
\n ", + "xmlname": "statusMessage" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n ", + "xmlname": "conversionTask" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates an import instance task using metadata from the specified disk image. After\n importing the image, you then upload it using the
us-east-1 region.A unique name for the key pair.
\n ", + "required": true + }, + "PublicKeyMaterial": { + "shape_name": "String", + "type": "blob", + "documentation": "\nThe public key. You must base64 encode the public key material before sending it to AWS.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ImportKeyPairResult", + "type": "structure", + "members": { + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key pair name you provided.
\n ", + "xmlname": "keyName" + }, + "KeyFingerprint": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe MD5 public key fingerprint as specified in section 4 of RFC 4716.
\n ", + "xmlname": "keyFingerprint" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nImports the public key from an RSA key pair that you created with a third-party tool. \n Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you \n (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. \n The private key is never transferred between you and AWS.
\nFor more information about key pairs, see Key Pairs \n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nThe Availability Zone for the resulting Amazon EBS\n volume.
\n ", + "required": true + }, + "Image": { + "shape_name": "DiskImageDetail", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true + }, + "Bytes": { + "shape_name": "Long", + "type": "long", + "documentation": "\n ", + "required": true + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true + } + }, + "documentation": "\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nAn optional description for the volume being imported.
\n " + }, + "Volume": { + "shape_name": "VolumeDetail", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume, in GiB.
\n ", + "required": true + } + }, + "documentation": "\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ImportVolumeResult", + "type": "structure", + "members": { + "ConversionTask": { + "shape_name": "ConversionTask", + "type": "structure", + "members": { + "ConversionTaskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the conversion task.
\n ", + "required": true, + "xmlname": "conversionTaskId" + }, + "ExpirationTime": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
\n ", + "xmlname": "expirationTime" + }, + "ImportInstance": { + "shape_name": "ImportInstanceTaskDetails", + "type": "structure", + "members": { + "Volumes": { + "shape_name": "ImportInstanceVolumeDetailSet", + "type": "list", + "members": { + "shape_name": "ImportInstanceVolumeDetailItem", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting instance will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the import of this particular disk image.
\n ", + "required": true, + "xmlname": "status" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status information or errors related to the disk image.
\n ", + "xmlname": "statusMessage" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nDescribes an import volume task.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "required": true, + "xmlname": "volumes" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "instanceId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe instance operating system.
\n ", + "xmlname": "platform" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n ", + "xmlname": "description" + } + }, + "documentation": "\nIf the task is for importing an instance, this contains information about the import instance task.
\n ", + "xmlname": "importInstance" + }, + "ImportVolume": { + "shape_name": "ImportVolumeTaskDetails", + "type": "structure", + "members": { + "BytesConverted": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe number of bytes converted so far.
\n ", + "required": true, + "xmlname": "bytesConverted" + }, + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where the resulting volume will reside.
\n ", + "required": true, + "xmlname": "availabilityZone" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description you provided when starting the import volume task.
\n ", + "xmlname": "description" + }, + "Image": { + "shape_name": "DiskImageDescription", + "type": "structure", + "members": { + "Format": { + "shape_name": "DiskImageFormat", + "type": "string", + "enum": [ + "VMDK", + "RAW", + "VHD" + ], + "documentation": "\nThe disk image format.
\n ", + "required": true, + "xmlname": "format" + }, + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the disk image.
\n ", + "required": true, + "xmlname": "size" + }, + "ImportManifestUrl": { + "shape_name": "String", + "type": "string", + "documentation": "\nA presigned URL for the import manifest stored in Amazon S3. For information about\n creating a presigned URL for an Amazon S3 object, read the\n \"Query String Request Authentication Alternative\" section of the\n Authenticating REST Requests topic in the\n Amazon Simple Storage Service Developer Guide.
\n ", + "required": true, + "xmlname": "importManifestUrl" + }, + "Checksum": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe checksum computed for the disk image.
\n ", + "xmlname": "checksum" + } + }, + "documentation": "\nThe image.
\n ", + "required": true, + "xmlname": "image" + }, + "Volume": { + "shape_name": "DiskImageVolumeDescription", + "type": "structure", + "members": { + "Size": { + "shape_name": "Long", + "type": "long", + "documentation": "\nThe size of the volume.
\n ", + "xmlname": "size" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe volume identifier.
\n ", + "required": true, + "xmlname": "id" + } + }, + "documentation": "\nThe volume.
\n ", + "required": true, + "xmlname": "volume" + } + }, + "documentation": "\nIf the task is for importing a volume, this contains information about the import volume task.
\n ", + "xmlname": "importVolume" + }, + "State": { + "shape_name": "ConversionTaskState", + "type": "string", + "enum": [ + "active", + "cancelling", + "cancelled", + "completed" + ], + "documentation": "\nThe state of the conversion task.
\n ", + "required": true, + "xmlname": "state" + }, + "StatusMessage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status message related to the conversion task.
\n ", + "xmlname": "statusMessage" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\n ", + "xmlname": "tagSet" + } + }, + "documentation": "\n ", + "xmlname": "conversionTask" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates an import volume task using metadata from the specified disk image.\n After importing the image, you then upload it using the\n
us-east-1 region.The ID of the AMI.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the attribute to modify.
\n " + }, + "OperationType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe operation type.
\n " + }, + "UserIds": { + "shape_name": "UserIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "UserId" + }, + "documentation": "\nOne or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
One or more user groups. This is only valid when modifying the launchPermission attribute.
One or more product codes. After you add a product code to an AMI, it can't be removed.\n This is only valid when modifying the productCodes attribute.
The value of the attribute being modified. This is only valid when modifying the description attribute.
The AWS account ID.
\n " + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe name of the group.
\n " + } + }, + "documentation": "\nDescribes a launch permission.
\n " + }, + "documentation": "\nThe AWS account ID to add to the list of launch permissions for the AMI.
\n ", + "flattened": true + }, + "Remove": { + "shape_name": "LaunchPermissionList", + "type": "list", + "members": { + "shape_name": "LaunchPermission", + "type": "structure", + "members": { + "UserId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID.
\n " + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe name of the group.
\n " + } + }, + "documentation": "\nDescribes a launch permission.
\n " + }, + "documentation": "\nThe AWS account ID to remove from the list of launch permissions for the AMI.
\n ", + "flattened": true + } + }, + "documentation": "\n \n " + }, + "Description": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\nA description for the AMI.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": " \nModifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
\nAWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.
The ID of the instance.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "InstanceAttributeName", + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\nThe name of the attribute.
\n " + }, + "Value": { + "shape_name": "String", + "type": "string", + "documentation": "\nA new value for the attribute. Use only with the kernel, ramdisk,\n userData, disableApiTermination, or\n intanceInitiateShutdownBehavior attribute.
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n " + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " + }, + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n " + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nsuppress the specified device included in the block device mapping.
\n " + } + }, + "documentation": "\nDescribes a block device mapping entry.
\n ", + "xmlname": "BlockDeviceMapping" + }, + "documentation": "\n\t\t\tModifies the DeleteOnTermination attribute for volumes\n\t\t\t\tthat are currently attached. The volume must be owned by the caller. If\n\t\t\t\tno value is specified for DeleteOnTermination, the default\n\t\t\t\tis true and the volume is deleted when the instance is\n\t\t\t\tterminated.
To add instance store volumes to an Amazon EBS-backed instance,\n\t\t\t\tyou must add them when you launch the instance. For more\n\t\t\t\tinformation, see Updating the Block Device Mapping when Launching an Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\n ", + "flattened": true + }, + "SourceDestCheck": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n " + } + }, + "documentation": "\nSpecifies whether source/destination checking is enabled.\n\t\t\t\tA value of true means that checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.
Specifies whether to disable the ability to terminate the instance using the Amazon EC2 console, CLI, and API.
\n " + }, + "InstanceType": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\nChanges the instance type to the specified value. For more information, see\n\t\t\t\tInstance Types.\n\t\t\t\tIf the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
Changes the instance's kernel to the specified value.
\n " + }, + "Ramdisk": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\nChanges the instance's RAM disk to the specified value.
\n " + }, + "UserData": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "blob", + "documentation": " \n " + } + }, + "documentation": "\nChanges the instance's user data to the specified value.
\n " + }, + "InstanceInitiatedShutdownBehavior": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\nSpecifies whether an instance stops or terminates when you initiate\n\t\t\t\tshutdown from the instance (using the operating system command for system shutdown).
\n " + }, + "Groups": { + "shape_name": "GroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "GroupId" + }, + "documentation": "\n\t\t\t[EC2-VPC] Changes the security groups of the instance. You must specify\n\t\t\t\tat least one security group, even if it's just the default security\n\t\t\t\tgroup for the VPC. You must specify the security group ID, not the\n\t\t\t\tsecurity group name.
\n\t\t\tFor example, if you want the instance to be in sg-1a1a1a1a and\n\t\t\t\tsg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and\n\t\t\t\tGroupId.2=sg-9b9b9b9b.
Specifies whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.
\n " + }, + "SriovNetSupport": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\nSet to simple to enable enhanced networking for the instance.
There is no way to disable enhanced networking at this time.
\nThis option is supported only for HVM instances. Specifying this option\n with a PV instance can make it unreachable.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\t\tModifies the specified attribute of the specified instance. You can specify only one attribute at a time.
\n\t\t\tTo modify some attributes, the instance must be stopped. For more information, see\n\t\t\t\tModifying Attributes of a Stopped Instance\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nstopped state.InstanceInitiatedShutdownBehavior attribute of the specified instance.DisableApiTermination attribute of the specified instance.The ID of the network interface.
\n ", + "required": true + }, + "Description": { + "shape_name": "AttributeValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "String", + "type": "string", + "documentation": " \n " + } + }, + "documentation": "\n\t\tA description for the network interface.
\n " + }, + "SourceDestCheck": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n " + } + }, + "documentation": "\n\t\tIndicates whether source/destination checking is enabled.\n\t\t\t\tA value of true means checking\n\t\t\t\tis enabled, and false means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT. For more\n\t\t\t\tinformation, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
Changes the security groups for the network interface. The new\n\t\t\t\tset of groups you specify replaces the current set. You must specify at\n\t\t\t\tleast one group, even if it's just the default security group in the\n\t\t\t\tVPC. You must specify the ID of the security group, not the name.
\n ", + "flattened": true + }, + "Attachment": { + "shape_name": "NetworkInterfaceAttachmentChanges", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n " + } + }, + "documentation": "\n\t\tThe ID of the interface attachment.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tModifies the specified network interface attribute. You can specify only one attribute at a time.
\nfalse for the\n\t\t\t\t\tspecified network interface.A unique, case-sensitive token you provide to ensure idempotency of your modification request.
\n " + }, + "ReservedInstancesIds": { + "shape_name": "ReservedInstancesIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ReservedInstancesId" + }, + "documentation": "\nThe IDs of the Reserved Instances to modify.
\n ", + "required": true, + "flattened": true + }, + "TargetConfigurations": { + "shape_name": "ReservedInstancesConfigurationList", + "type": "list", + "members": { + "shape_name": "ReservedInstancesConfiguration", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone for the modified Reserved Instances.
\n " + }, + "Platform": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
\n " + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of modified Reserved Instances.
\n " + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type for the modified Reserved Instances.
\n " + } + }, + "documentation": "\nDescribes the configuration settings for the modified Reserved Instances.
\n ", + "xmlname": "ReservedInstancesConfigurationSetItemType" + }, + "documentation": "\nThe configuration settings for the Reserved Instances to modify.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ModifyReservedInstancesResult", + "type": "structure", + "members": { + "ReservedInstancesModificationId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID for the modification.
\n ", + "xmlname": "reservedInstancesModificationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nModifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
\nThe ID of the snapshot.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "SnapshotAttributeName", + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\nThe snapshot attribute to modify.
\n " + }, + "OperationType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe type of operation to perform to the attribute.
\n " + }, + "UserIds": { + "shape_name": "UserIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "UserId" + }, + "documentation": "\nThe account ID to modify for the snapshot.
\n ", + "flattened": true + }, + "GroupNames": { + "shape_name": "GroupNameStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "UserGroup" + }, + "documentation": "\nThe group to modify for the snapshot.
\n ", + "flattened": true + }, + "CreateVolumePermission": { + "shape_name": "CreateVolumePermissionModifications", + "type": "structure", + "members": { + "Add": { + "shape_name": "CreateVolumePermissionList", + "type": "list", + "members": { + "shape_name": "CreateVolumePermission", + "type": "structure", + "members": { + "UserId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n " + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n " + } + }, + "documentation": "\n " + }, + "documentation": "\nAdds a specific AWS account ID or group to a volume's list of create volume permissions.
\n ", + "flattened": true + }, + "Remove": { + "shape_name": "CreateVolumePermissionList", + "type": "list", + "members": { + "shape_name": "CreateVolumePermission", + "type": "structure", + "members": { + "UserId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe specific AWS account ID that is to be added or removed from a volume's list of create\n volume permissions.
\n " + }, + "Group": { + "shape_name": "PermissionGroup", + "type": "string", + "enum": [ + "all" + ], + "documentation": "\nThe specific group that is to be added or removed from a volume's list of create volume\n permissions.
\n " + } + }, + "documentation": "\n " + }, + "documentation": "\nRemoves a specific AWS account ID or group from a volume's list of create volume\n permissions.
\n ", + "flattened": true + } + }, + "documentation": "\nA JSON representation of the snapshot attribute modification.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nAdds or removes permission settings for the specified snapshot. You may add or remove\n specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot\n do both in a single API call. If you need to both add and remove account IDs for a snapshot,\n you must use multiple API calls.
\nFor more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.
\nSnapshots with AWS Marketplace product codes cannot be made public.
\nsnap-1a2b3c4d snapshot public, and gives\n the account with ID 111122223333 permission to create volumes from\n the snapshot.snap-1a2b3c4d snapshot public, and removes\n the account with ID 111122223333 from the list of users with\n permission to create volumes from the snapshot.The ID of the subnet.
\n\t", + "required": true + }, + "MapPublicIpOnLaunch": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n " + } + }, + "documentation": " \n " + } + }, + "documentation": "\n\t" + }, + "output": null, + "errors": [], + "documentation": "\n\t\tModifies a subnet attribute.
\n\t\tsubnet-1a2b3c4d to specify\n\t\t\t\t\tthat all instances launched into this subnet are assigned a public IP address. The ID of the volume.
\n ", + "required": true + }, + "AutoEnableIO": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n " + } + }, + "documentation": "\nIndicates whether the volume should be auto-enabled for I/O operations.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nModifies a volume attribute.
\nBy default, all I/O operations for the volume are suspended when the data on the volume is\n determined to be potentially inconsistent, to prevent undetectable, latent data corruption.\n The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
\nYou can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes\n or for volumes that are stateless or disposable.
\nThe ID of the VPC.
\n ", + "required": true + }, + "EnableDnsSupport": { + "shape_name": "AttributeBooleanValue", + "type": "structure", + "members": { + "Value": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": " \n " + } + }, + "documentation": "\n\t\tIndicates whether the DNS resolution is supported for the VPC. If this attribute is\n false, the Amazon provided DNS service in the VPC that resolves public DNS\n hostnames to IP addresses is not enabled. If this attribute is true, queries to\n the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address\n at the base of the VPC network range \"plus two\" will succeed.
Indicates whether the instances launched in the VPC get DNS\n\t\t\t\thostnames. If this attribute is true, instances in the VPC\n\t\t\t\tget DNS hostnames; otherwise, they do not.
You can only set enableDnsHostnames to true if you also\n\t\t\t\tset the EnableDnsSupport attribute to true.
Modifies the specified attribute of the specified VPC.
\nOne or more instance IDs.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "MonitorInstancesResult", + "type": "structure", + "members": { + "InstanceMonitorings": { + "shape_name": "InstanceMonitoringList", + "type": "list", + "members": { + "shape_name": "InstanceMonitoring", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Monitoring": { + "shape_name": "Monitoring", + "type": "structure", + "members": { + "State": { + "shape_name": "MonitoringState", + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nThe monitoring information.
\n ", + "xmlname": "monitoring" + } + }, + "documentation": "\nDescribes the monitoring information of the instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nMonitoring information for one or more instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nEnables monitoring for a running instance. For more information about monitoring instances,\n\t\t\tsee Monitoring Your Instances and Volumes\n\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the Reserved Instance offering to purchase.
\n ", + "required": true + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of Reserved Instances to purchase.
\n ", + "required": true + }, + "LimitPrice": { + "shape_name": "ReservedInstanceLimitPrice", + "type": "structure", + "members": { + "Amount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nUsed for Reserved Instance Marketplace offerings. Specifies the limit price on the total order\n\t\t\t\t(instanceCount * price).
\n " + }, + "CurrencyCode": { + "shape_name": "CurrencyCodeValues", + "type": "string", + "enum": [ + "USD" + ], + "documentation": "\nThe currency in which the limitPrice amount is specified.\n\t\t\t\tAt this time, the only supported currency is USD.
Specified for Reserved Instance Marketplace offerings to limit the total order and\n\t\t\t\tensure that the Reserved Instances are not purchased at unexpected prices.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "PurchaseReservedInstancesOfferingResult", + "type": "structure", + "members": { + "ReservedInstancesId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe IDs of the purchased Reserved Instances.
\n ", + "xmlname": "reservedInstancesId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nPurchases a Reserved Instance for use with your account. With Amazon EC2 Reserved\n\t\t\t\tInstances, you obtain a capacity reservation for a certain instance configuration\n\t\t\t\tover a specified period of time. You pay a lower usage rate than with On-Demand\n\t\t\t\tinstances for the time that you actually use the capacity reservation.
\nFor more information, see Reserved Instance Marketplace\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\t\tRequests a reboot of one or more instances. This operation is asynchronous; it\n\t\t\t\tonly queues a request to reboot the specified instances. The operation\n\t\t\t\tsucceeds if the instances are valid and belong to you. Requests to reboot terminated\n\t\t\t\tinstances are ignored.
\n\t\t\tIf a Linux/Unix instance does not cleanly shut down within four minutes,\n\t\t\t\tAmazon EC2 performs a hard reboot.
\nFor more information about troubleshooting, see Getting Console Output and Rebooting Instances in the\n Amazon Elastic Compute Cloud User Guide.
\nThe full path to your AMI manifest in Amazon S3 storage.
\n " + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nA name for your AMI.
\nConstraints: 3-128 alphanumeric characters, parenthesis (()),\n\t\t\t\tcommas (,), slashes (/), dashes (-), or underscores (_)
\n ", + "required": true + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for your AMI.
\n " + }, + "Architecture": { + "shape_name": "ArchitectureValues", + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\nThe architecture of the AMI.
\nDefault: For Amazon EBS-backed AMIs, i386.\n For instance store-backed AMIs, the architecture specified in the manifest file.
The ID of the kernel.
\n " + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the RAM disk.
\n " + }, + "RootDeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the root device (for example, /dev/sda1, or\n\t\t\t\txvda).
The virtual device name.
\n " + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n " + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "BlockDeviceMapping" + }, + "documentation": "\nOne or more block device mapping entries.
\n ", + "flattened": true + }, + "VirtualizationType": { + "shape_name": "String", + "type": "string", + "documentation": "The type of virtualization", + "enum": [ + "paravirtual", + "hvm" + ] + }, + "SriovNetSupport": { + "shape_name": "String", + "type": "string", + "documentation": "\nSet to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.
There is no way to disable enhanced networking at this time.
\nThis option is supported only for HVM AMIs. Specifying this option\n with a PV AMI can make instances launched from the AMI unreachable.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "RegisterImageResult", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the newly registered AMI.
\n ", + "xmlname": "imageId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": " \nRegisters an AMI. When you're creating an AMI, this is the final step\n\t\t\t\tyou must complete before you can launch an instance from the AMI. For more\n\t\t\t\tinformation about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
\nFor Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage to create an Amazon EBS-backed AMI\n\t\t\t\tfrom a snapshot of a root device volume. For more information, see\n\t\t\t\tLaunching an\n\t\t\t\t\tInstance from a Snapshot in the\n\t\t\t\tAmazon Elastic Compute Cloud User Guide.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI\n\t\t\t\tbacked by an instance store volume invalidates its registration. If you make changes to an image,\n\t\t\t\tderegister the previous image and register the new image.
\nYou can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
my-new-image.manifest.xml manifest file, located in the bucket\n\t\t\t\t\tcalled myawsbucket.The ID of the VPC peering connection.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "RejectVpcPeeringConnectionResult", + "type": "structure", + "members": { + "Return": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nReturns true if the request succeeds; otherwise, it returns an error.
Rejects a VPC peering connection request. The VPC peering connection must be in the\n pending-acceptance state. Use the DescribeVpcPeeringConnections request to\n view your outstanding VPC peering connection requests.
[EC2-Classic] The Elastic IP address.
\n " + }, + "AllocationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The allocation ID.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nReleases the specified Elastic IP address.
\nAfter releasing an Elastic IP address, it is released to the IP address\n\t\t\t\tpool and might be unavailable to you. Be sure to update your DNS records and any\n\t\t\t\tservers or devices that communicate with the address. If you attempt to release\n\t\t\t\tan Elastic IP address that you already released, you'll get an\n\t\t\t\tAuthFailure error if the address is already allocated to\n\t\t\t\tanother AWS account.
[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it\n\t\t\t\tfrom any instance that it's associated with. To disassociate an Elastic IP address\n\t\t\t\twithout releasing it, use DisassociateAddress.
\n[Nondefault VPC] You must use the DisassociateAddress to\n\t\t\t\tdisassociate the Elastic IP address before you try to release it. Otherwise, \n\t\t\t\tAmazon EC2 returns an error (InvalidIPAddress.InUse).
The ID of the current association between the original\n\t\t\t\tnetwork ACL and the subnet.
\n ", + "required": true + }, + "NetworkAclId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the new ACL to associate with the subnet.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ReplaceNetworkAclAssociationResult", + "type": "structure", + "members": { + "NewAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the new association.
\n ", + "xmlname": "newAssociationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tChanges which network ACL a subnet is associated with. By default when you create\n\t\t\t\ta subnet, it's automatically associated with the default network ACL. For more\n\t\t\t\tinformation about network ACLs, see Network\n\t\t\t\tACLs in the Amazon Virtual Private Cloud User Guide.
\naclassoc-e5b95c8c. You want to associate a\n\t\t\t\t\tdifferent network ACL (acl-5fb85d36) with the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.The ID of the ACL.
\n ", + "required": true + }, + "RuleNumber": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe rule number of the entry to replace.
\n ", + "required": true + }, + "Protocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe IP protocol. You can specify all or -1 to mean all protocols.
Indicates whether to allow or deny the traffic that matches the rule.
\n ", + "required": true + }, + "Egress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether to replace the egress rule.
\n\t\tDefault: If no value is specified, we replace the ingress rule.
\n ", + "required": true + }, + "CidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe network range to allow or deny, in CIDR notation.
\n ", + "required": true + }, + "IcmpTypeCode": { + "shape_name": "IcmpTypeCode", + "type": "structure", + "members": { + "Type": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP code. A value of -1 means all codes for the specified ICMP type.
\n " + }, + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe ICMP type. A value of -1 means all types.
\n " + } + }, + "documentation": "\n\t\tICMP protocol: The ICMP type and code.
\n ", + "xmlname": "Icmp" + }, + "PortRange": { + "shape_name": "PortRange", + "type": "structure", + "members": { + "From": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe first port in the range.
\n " + }, + "To": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe last port in the range.
\n " + } + }, + "documentation": "\n\t\tTCP or UDP protocols: The range of ports the rule applies to.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tReplaces an entry (rule) in a network ACL. For more information about network ACLs,\n\t\t\t\tsee Network ACLs in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
\n110 in the network ACL with ID\n\t\t\t\t\tacl-2cb85d45. The new rule denies egress traffic destined for anywhere\n\t\t\t\t\t(0.0.0.0/0) on TCP port 139.The ID of the route table.
\n ", + "required": true + }, + "DestinationCidrBlock": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR address block used for the destination match. The value\n\t\t\t\tyou provide must match the CIDR of an existing route in the table.
\n ", + "required": true + }, + "GatewayId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of an Internet gateway attached to your VPC.
\n " + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a NAT instance in your VPC.
\n " + }, + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of a network interface.
\n " + }, + "VpcPeeringConnectionId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of a VPC peering connection.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tReplaces an existing route within a route table in a VPC. You must provide only one of the following: \n\t\t Internet gateway, NAT instance, VPC peering connection, or network interface.
\n\t\tFor more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
\n10.0.0.0/8 and sends the traffic to the virtual private gateway with\n\t\t\t\t\tthe ID vgw-1d00376e.The association ID.
\n ", + "required": true + }, + "RouteTableId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the new route table to associate with the subnet.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "ReplaceRouteTableAssociationResult", + "type": "structure", + "members": { + "NewAssociationId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the new association.
\n ", + "xmlname": "newAssociationId" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\tChanges the route table associated with a given subnet in a VPC. After the\n\t\t\t\toperation completes, the subnet uses the routes in the new route table it's associated with.\n\t\t\t\tFor more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
\nYou can also use ReplaceRouteTableAssociation to change which table is the main route table in the\n\t\t\t\tVPC. You just specify the main route table's association ID and the route table to be the new main route table.
\nrtbassoc-f8ad4891. You want to associate a\n\t\t\t\t\tdifferent route table (table rtb-f9ad4890) to the subnet. The result is a new\n\t\t\t\t\tassociation ID representing the new association.One or more instances.
\n ", + "required": true, + "flattened": true + }, + "Status": { + "shape_name": "ReportStatusType", + "type": "string", + "enum": [ + "ok", + "impaired" + ], + "documentation": "\nThe status of all instances listed.
\n ", + "required": true + }, + "StartTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time at which the reported instance health state began.
\n " + }, + "EndTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time at which the reported instance health state ended.
\n " + }, + "ReasonCodes": { + "shape_name": "ReasonCodesList", + "type": "list", + "members": { + "shape_name": "ReportInstanceReasonCodes", + "type": "string", + "enum": [ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ], + "documentation": null, + "xmlname": "ReasonCode" + }, + "documentation": "\nOne or more reason codes that describes the health state of your instance.
\ninstance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems which I believe are network related.
performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
Descriptive text about the health state of your instance.
\n " + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\t\tSubmits feedback about the status of an instance. The instance\n\t\t\t\tmust be in the running state. If your experience\n\t\t\t\twith the instance differs from the instance status returned by\n\t\t\t\tDescribeInstanceStatus, use ReportInstanceStatus\n\t\t\t\tto report your experience with the instance. Amazon EC2 collects\n\t\t\t\tthis information to improve the accuracy of status checks.
The maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", + "required": true + }, + "InstanceCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of Spot Instances to launch.
\nDefault: 1
\n " + }, + "Type": { + "shape_name": "SpotInstanceType", + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\nThe Spot Instance request type.
\nDefault: one-time
The start date of the request. If this is a one-time request, the\n\t\t\t\trequest becomes active at this date and time and remains active until\n\t\t\t\tall instances launch, the request expires, or the request is canceled.\n\t\t\t\tIf the request is persistent, the request becomes active at this date\n\t\t\t\tand time and remains active until it expires or is canceled.
\nDefault: The request is effective indefinitely.
\n " + }, + "ValidUntil": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe end date of the request. If this is a one-time request, the\n\t\t\t\trequest remains active until all instances launch, the request is\n\t\t\t\tcanceled, or this date is reached. If the request is persistent, it\n\t\t\t\tremains active until it is canceled or this date and time is reached.
\nDefault: The request is effective indefinitely.
\n " + }, + "LaunchGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe instance launch group. Launch groups are Spot Instances that\n\t\t\t\tlaunch together and terminate together.
\nDefault: Instances are launched and terminated individually
\n " + }, + "AvailabilityZoneGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-specified name for a logical grouping of bids.
\nWhen you specify an Availability Zone group in a Spot\n\t\t\t\tInstance request, all Spot Instances in the request are launched in the\n\t\t\t\tsame Availability Zone. Instance proximity is maintained with this\n\t\t\t\tparameter, but the choice of Availability Zone is not.\n\t\t\t\tThe group applies only to bids for Spot\tInstances of the same instance type. \n\t\t\t\tAny additional Spot Instance requests that are specified with the same\n\t\t\t\tAvailability Zone group name are launched in that\n\t\t\t\tsame Availability Zone, as long as at least one instance from the group\n\t\t\t\tis still active.
\nIf there is no active instance running in the Availability Zone\n\t\t\t\tgroup that you specify for a new Spot Instance request (all\n\t\t\t\tinstances are terminated, the bid is expired, or the bid falls below\n\t\t\t\tcurrent market), then Amazon EC2 launches the instance in any\n\t\t\t\tAvailability Zone where the constraint can be met. Consequently, the\n\t\t\t\tsubsequent set of Spot Instances could be placed in a different zone\n\t\t\t\tfrom the original request, even if you specified the same\n\t\t\t\tAvailability Zone group.
\nDefault: Instances are launched in any available Availability Zone.
\n " + }, + "LaunchSpecification": { + "shape_name": "LaunchSpecification", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI.
\n " + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair.
\n " + }, + "UserData": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n " + }, + "AddressingType": { + "shape_name": "String", + "type": "string", + "documentation": "\n \n " + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n " + }, + "Placement": { + "shape_name": "SpotPlacement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone group name.
\n " + } + }, + "documentation": "\nThe placement information for the instance.
\n " + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the kernel.
\n " + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the RAM disk.
\n " + }, + "BlockDeviceMappings": { + "shape_name": "BlockDeviceMappingList", + "type": "list", + "members": { + "shape_name": "BlockDeviceMapping", + "type": "structure", + "members": { + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n " + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n " + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "BlockDeviceMapping" + }, + "documentation": "\nOne or more block device mapping entries.
\n ", + "flattened": true + }, + "Monitoring": { + "type": "structure", + "members": { + "Enabled": { + "shape_name": "Boolean", + "type": "boolean", + "required": true, + "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n " + } + } + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\n " + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceSpecificationList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterfaceSpecification", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n " + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n " + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description of the network interface.
\n " + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n " + }, + "Groups": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", + "flattened": true + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", + "required": true + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " + } + }, + "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n " + }, + "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", + "flattened": true + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of secondary private IP addresses.
\n " + }, + "AssociatePublicIpAddress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.
\n " + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "NetworkInterface" + }, + "documentation": "\nOne or more network interfaces.
\n ", + "flattened": true + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfileSpecification", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n " + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the instance profile.
\n " + } + }, + "documentation": "\nThe IAM instance profile.
\n " + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.
\nDefault: false
The launch specification.
\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "RequestSpotInstancesResult", + "type": "structure", + "members": { + "SpotInstanceRequests": { + "shape_name": "SpotInstanceRequestList", + "type": "list", + "members": { + "shape_name": "SpotInstanceRequest", + "type": "structure", + "members": { + "SpotInstanceRequestId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestId" + }, + "SpotPrice": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe maximum hourly price for any Spot Instance launched to fulfill the request.
\n ", + "xmlname": "spotPrice" + }, + "Type": { + "shape_name": "SpotInstanceType", + "type": "string", + "enum": [ + "one-time", + "persistent" + ], + "documentation": "\nThe Spot Instance request type.
\n ", + "xmlname": "type" + }, + "State": { + "shape_name": "SpotInstanceState", + "type": "string", + "enum": [ + "open", + "active", + "closed", + "cancelled", + "failed" + ], + "documentation": "\nThe state of the Spot Instance request. Spot bid status information can help you track your \n\t\t\t\tSpot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.
\n ", + "xmlname": "state" + }, + "Fault": { + "shape_name": "SpotInstanceStateFault", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the Spot Instance state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the Spot Instance state change.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe fault codes for the Spot Instance request, if any.
\n ", + "xmlname": "fault" + }, + "Status": { + "shape_name": "SpotInstanceStatus", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status code of the request.
\n ", + "xmlname": "code" + }, + "UpdateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time of the most recent status update.
\n ", + "xmlname": "updateTime" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for the status code for the Spot request.
\n ", + "xmlname": "message" + } + }, + "documentation": "\nThe status code and status message describing the Spot Instance request.
\n ", + "xmlname": "status" + }, + "ValidFrom": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe start date of the request. If this is a one-time request, the request becomes\n\t\t\t\tactive at this date and time and remains active until all\n\t\t\t\tinstances launch, the request expires, or the request is\n\t\t\t\tcanceled. If the request is persistent, the request becomes\n\t\t\t\tactive at this date and time and remains active until it expires\n\t\t\t\tor is canceled.
\n ", + "xmlname": "validFrom" + }, + "ValidUntil": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe end date of the request. If this is a one-time request, the request remains\n\t\t\t\tactive until all instances launch, the request is canceled, or\n\t\t\t\tthis date is reached. If the request is persistent, it remains\n\t\t\t\tactive until it is canceled or this date is reached.
\n ", + "xmlname": "validUntil" + }, + "LaunchGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe instance launch group. Launch groups are Spot Instances that launch\n\t\t\t\ttogether and terminate together.
\n ", + "xmlname": "launchGroup" + }, + "AvailabilityZoneGroup": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone group. If you specify the same Availability Zone group\n\t\t\t\tfor all Spot Instance requests, all Spot Instances are launched in the same\n\t\t\t\tAvailability Zone.
\n ", + "xmlname": "availabilityZoneGroup" + }, + "LaunchSpecification": { + "shape_name": "LaunchSpecification", + "type": "structure", + "members": { + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI.
\n ", + "xmlname": "imageId" + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair.
\n ", + "xmlname": "keyName" + }, + "SecurityGroups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "UserData": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Base64-encoded MIME user data to make available to the instances.
\n ", + "xmlname": "userData" + }, + "AddressingType": { + "shape_name": "String", + "type": "string", + "documentation": "\n \n ", + "xmlname": "addressingType" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "Placement": { + "shape_name": "SpotPlacement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone.
\n ", + "xmlname": "availabilityZone" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone group name.
\n ", + "xmlname": "groupName" + } + }, + "documentation": "\nThe placement information for the instance.
\n ", + "xmlname": "placement" + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the kernel.
\n ", + "xmlname": "kernelId" + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the RAM disk.
\n ", + "xmlname": "ramdiskId" + }, + "BlockDeviceMappings": { + "shape_name": "BlockDeviceMappingList", + "type": "list", + "members": { + "shape_name": "BlockDeviceMapping", + "type": "structure", + "members": { + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n ", + "xmlname": "virtualName" + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n ", + "xmlname": "snapshotId" + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n ", + "xmlname": "volumeSize" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n ", + "xmlname": "encrypted" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n ", + "xmlname": "noDevice" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more block device mapping entries.
\n ", + "xmlname": "blockDeviceMapping" + }, + "MonitoringEnabled": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nEnables monitoring for the instance.
\nDefault: Disabled
\n ", + "xmlname": "monitoringEnabled" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the subnet in which to launch the Spot Instance.
\n ", + "xmlname": "subnetId" + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceSpecificationList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterfaceSpecification", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", + "xmlname": "deviceIndex" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n ", + "xmlname": "subnetId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description of the network interface.
\n ", + "xmlname": "description" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n ", + "xmlname": "privateIpAddress" + }, + "Groups": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", + "xmlname": "SecurityGroupId" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", + "required": true, + "xmlname": "privateIpAddress" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n ", + "xmlname": "primary" + } + }, + "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of secondary private IP addresses.
\n ", + "xmlname": "secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.
\n ", + "xmlname": "associatePublicIpAddress" + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more network interfaces.
\n ", + "xmlname": "networkInterfaceSet" + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfileSpecification", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", + "xmlname": "arn" + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the instance profile.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe IAM instance profile.
\n ", + "xmlname": "iamInstanceProfile" + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal EBS I/O performance. This\n\t\t\t\toptimization isn't available with all instance types. Additional usage\n\t\t\t\tcharges apply when using an EBS Optimized instance.
\nDefault: false
Additional information for launching instances.
\n ", + "xmlname": "launchSpecification" + }, + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe instance ID, if an instance has been launched to fulfill the Spot Instance\n\t\t\t\trequest.
\n ", + "xmlname": "instanceId" + }, + "CreateTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the Spot Instance request was created.
\n ", + "xmlname": "createTime" + }, + "ProductDescription": { + "shape_name": "RIProductDescription", + "type": "string", + "enum": [ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ], + "documentation": "\nThe product description associated with the Spot Instance.
\n ", + "xmlname": "productDescription" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the resource.
\n ", + "xmlname": "tagSet" + }, + "LaunchedAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone in which the bid is launched.
\n ", + "xmlname": "launchedAvailabilityZone" + } + }, + "documentation": "\nDescribe a Spot Instance request.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\nCreates a Spot Instance request. Spot Instances are instances that Amazon EC2\n\t\t\t\tstarts on your behalf when the maximum price that you specify exceeds the current\n\t\t\t\tSpot Price. Amazon EC2 periodically sets the Spot Price based on available Spot\n\t\t\t\tInstance capacity and current Spot Instance requests. For more information about\n\t\t\t\tSpot Instances, see Spot\n\t\t\t\tInstances in the Amazon Elastic Compute Cloud User Guide.
\nm1.small\n\t\t\t\t\tinstances and associates an IAM instance profile called s3access\n\t\t\t\t\twith them.pending-evaluation\n The ID of the AMI.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "ResetImageAttributeName", + "type": "string", + "enum": [ + "launchPermission" + ], + "documentation": "\nThe attribute to reset (currently you can only reset the launch\n\t\t\t\tpermission attribute).
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": " \nResets an attribute of an AMI to its default value.
\nlaunchPermission attribute for the\n\t\t\t\t\tspecified AMI.The ID of the instance.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "InstanceAttributeName", + "type": "string", + "enum": [ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ], + "documentation": "\nThe attribute to reset.
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\t\tResets an attribute of an instance to its default value. To reset the kernel or\n\t\t\t\tRAM disk, the instance must be in a stopped state. To reset the\n\t\t\t\tSourceDestCheck, the instance can be either running or stopped.
The SourceDestCheck attribute controls whether\n\t\t\t\tsource/destination checking is enabled. The default value is\n\t\t\t\ttrue, which means checking is enabled. This value must be\n\t\t\t\tfalse for a NAT instance to perform NAT. For more information, see\n\t\t\t\tNAT Instances in the\n\t\t\t\tAmazon Virtual Private Cloud User Guide.
sourceDestCheck attribute.The ID of the network interface.
\n ", + "required": true + }, + "SourceDestCheck": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tIndicates whether source/destination checking is enabled. A value\n\t\t\t\tof true means checking is enabled, and\n\t\t\t\tfalse means checking is disabled. This value\n\t\t\t\tmust be false for a NAT instance to perform NAT.
Resets a network interface attribute. You can specify only one attribute at a time.
\nsourceDestCheck attribute for the \n\t\t\t\t specified network interface.The ID of the snapshot.
\n ", + "required": true + }, + "Attribute": { + "shape_name": "SnapshotAttributeName", + "type": "string", + "enum": [ + "productCodes", + "createVolumePermission" + ], + "documentation": "\nThe attribute to reset (currently only the attribute for permission to create volumes can be\n reset).
\n ", + "required": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nResets permission settings for the specified snapshot.
\nFor more information on modifying snapshot permissions, see Sharing Snapshots in the\n Amazon Elastic Compute Cloud User Guide.
\nsnap-1a2b3c4d, making it a\n private snapshot that can only be used by the account that created it.The ID of the security group.
\n ", + "required": true + }, + "SourceSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "SourceSecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " + }, + "IpPermissions": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n " + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "Groups" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "flattened": true + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n " + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "flattened": true + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n " + }, + "documentation": "\n \n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nRemoves one or more egress rules from a security group for EC2-VPC. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be revoked.
\nEach rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.
\nRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n205.192.0.0/16 and 205.159.0.0/16\n\t\t\t\t\taddress ranges on TCP port 80.sg-9a8d7f5c on TCP\tport 1433.[EC2-Classic, default VPC] The name of the security group.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n " + }, + "SourceSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "SourceSecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the source security group. You can't specify a source security group and a CIDR IP address range.
\n " + }, + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe IP protocol name (tcp, udp, icmp) or number \n (see Protocol Numbers). \n Use -1 to specify all.
The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, \n use -1 to specify all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, \n use -1 to specify all ICMP codes for the ICMP type.
The CIDR IP address range. You can't specify this parameter when specifying a source security group.
\n " + }, + "IpPermissions": { + "shape_name": "IpPermissionList", + "type": "list", + "members": { + "shape_name": "IpPermission", + "type": "structure", + "members": { + "IpProtocol": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe protocol.
\n\t\tWhen you call DescribeSecurityGroups, the protocol value\n\t\t\t\treturned is the number. Exception: For TCP, UDP, and ICMP, the\n\t\t\t\tvalue returned is the name (for example, tcp,\n\t\t\t\tudp, or icmp). For a list of\n\t\t\t\tprotocol numbers, see Protocol Numbers.
The start of port range for the TCP and UDP protocols, or an ICMP type number. A\n\t\t\t\tvalue of -1 indicates all ICMP types.
The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1\n\t\t\t\tindicates all ICMP codes for the specified ICMP type.
The ID of an AWS account.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group owned by the specified AWS account.
\n " + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group in the specified AWS account.
\n " + } + }, + "documentation": "\nDescribes a security group and AWS account ID pair for EC2-Classic.
\n ", + "xmlname": "Groups" + }, + "documentation": "\n\t\tOne or more security group and AWS account ID pairs.
\n ", + "flattened": true + }, + "IpRanges": { + "shape_name": "IpRangeList", + "type": "list", + "members": { + "shape_name": "IpRange", + "type": "structure", + "members": { + "CidrIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe CIDR range. You can either specify a CIDR range or a source security group, not both.
\n " + } + }, + "documentation": "\n\t\tDescribes an IP range.
\n " + }, + "documentation": "\n\t\tOne or more IP ranges.
\n ", + "flattened": true + } + }, + "documentation": "\n\t\tDescribes a security group rule.
\n " + }, + "documentation": "\n \n ", + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\nRemoves one or more ingress rules from a security group. The values\n\t\t\t\tthat you specify in the revoke request (for example, ports) must match the existing\n\t\t\t\trule's values for the rule to be removed.
\nEach rule consists of the protocol and the CIDR range or source security\n\t\t\t\tgroup. For the TCP and UDP protocols, you must also specify the destination port or\n\t\t\t\trange of ports. For the ICMP protocol, you must also specify the ICMP type and code.
\nRule changes are propagated to instances within the security group as quickly as\n\t\t\t\tpossible. However, a small delay might occur.
\n205.192.0.0/16 address range\n\t\t\t\t\tfor the security group named websrv. If the security group is for\n\t\t\t\t\ta VPC, specify the ID of the security group instead of the name.The ID of the AMI, which you can get by calling DescribeImages.
\n ", + "required": true + }, + "MinCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe minimum number of instances to launch. If you specify a minimum that is more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
\nConstraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
\n ", + "required": true + }, + "MaxCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe maximum number of instances to launch. If you specify more instances\n than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the\n largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you're allowed for the specified instance type. \n For more information about the default limits, and how to request an increase, see \n How\n many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
\n ", + "required": true + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
\nIf you launch an instance without specifying a key pair, you can't connect to the instance.
\n[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use\n security group IDs instead.
\nDefault: Amazon EC2 uses the default security group.
\n ", + "flattened": true + }, + "SecurityGroupIds": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\nOne or more security group IDs. You can create a security group using CreateSecurityGroup.
\nDefault: Amazon EC2 uses the default security group.
\n ", + "flattened": true + }, + "UserData": { + "shape_name": "String", + "type": "blob", + "documentation": "\nThe user data for the instances. You can specify the user data as a string, or if the user data contents are in a file, you can use file://filename.
\n " + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
\nDefault: m1.small
The Availability Zone of the instance.
\n " + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n " + }, + "Tenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The placement for the instance.
\n " + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the kernel.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more information,\n see \n PV-GRUB: A New Amazon Kernel Image in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the RAM disk.
\n " + }, + "BlockDeviceMappings": { + "shape_name": "BlockDeviceMappingRequestList", + "type": "list", + "members": { + "shape_name": "BlockDeviceMapping", + "type": "structure", + "members": { + "VirtualName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe virtual device name.
\n " + }, + "DeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe device name exposed to the instance (for example, /dev/sdh).
The ID of the snapshot.
\n " + }, + "VolumeSize": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe size of the volume, in GiB.
\nConstraints: If the volume type is io1, the minimum size of the volume is 10\n GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB.
Default: If you're creating the volume from a snapshot and\n don't specify a volume size, the default is the snapshot size.
\n " + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the Amazon EBS volume is deleted on instance termination.
\n " + }, + "VolumeType": { + "shape_name": "VolumeType", + "type": "string", + "enum": [ + "standard", + "io1", + "gp2" + ], + "documentation": "\nThe volume type. gp2 for General Purpose (SSD) volumes,\n io1 for Provisioned IOPS (SSD) volumes, and standard for\n Magnetic volumes.
Default: standard
The number of I/O operations per second (IOPS) that the volume supports. For\n Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are\n provisioned for the volume. For General Purpose (SSD) volumes, this represents the\n baseline performance of the volume and the rate at which the volume\n accumulates I/O credits for bursting. For more information on General Purpose (SSD)\n baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types\n in the Amazon Elastic Compute Cloud User Guide.
\nConstraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD)\n volumes.
\nCondition: This parameter is required for requests to create io1 volumes; it is\n not used in requests to create standard or gp2 volumes.
Indicates whether the Amazon EBS volume is encrypted.
\n " + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n " + }, + "NoDevice": { + "shape_name": "String", + "type": "string", + "documentation": "\nSuppresses the specified device included in the block device mapping of the AMI.
\n " + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "BlockDeviceMapping" + }, + "documentation": "\nThe block device mapping.
\n ", + "flattened": true + }, + "Monitoring": { + "shape_name": "RunInstancesMonitoringEnabled", + "type": "structure", + "members": { + "Enabled": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", + "required": true + } + }, + "documentation": "\nThe monitoring for the instance.
\n " + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n[EC2-VPC] The ID of the subnet to launch the instance into.
\n " + }, + "DisableApiTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf you set this parameter to true, you can't terminate the instance using the Amazon EC2\n console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want\n to be able to terminate the instance, you must first change the value of the\n disableApiTermination attribute to false using\n ModifyInstanceAttribute. Alternatively, if you set\n InstanceInitiatedShutdownBehavior to terminate,\n you can terminate the instance by running the shutdown command from the instance.
Default: false
Indicates whether an instance stops or terminates when you initiate\n shutdown from the instance (using the operating system command for system shutdown).
\nDefault: stop
[EC2-VPC] The primary IP address. You must specify a value\n from the IP address range of the subnet.
\nOnly one private IP address can be designated as primary.\n Therefore, you can't specify this parameter if\n PrivateIpAddresses.n.Primary is set to\n true and PrivateIpAddresses.n.PrivateIpAddress\n is set to an IP address.
Default: We select an IP address from the IP address range of the subnet.
\n " + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nUnique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information,\n see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
\nConstraints: Maximum 64 ASCII characters
\n " + }, + "AdditionalInfo": { + "shape_name": "String", + "type": "string", + "documentation": "\nReserved.
\n " + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceSpecificationList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterfaceSpecification", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n " + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n " + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet associated with the network string.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description of the network interface.
\n " + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n " + }, + "Groups": { + "shape_name": "SecurityGroupIdStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\n\t\tThe IDs of the security groups for the network interface.
\n ", + "flattened": true + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIf set to true, the interface is deleted when the instance is terminated.
The private IP addresses.
\n ", + "required": true + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the private IP address is the primary private IP address.
\n " + } + }, + "documentation": "\n\t\tDescribes a secondary private IP address for a network interface.
\n ", + "xmlname": "PrivateIpAddresses" + }, + "documentation": "\n\t\tOne or more private IP addresses to assign to the network interface.
\n ", + "flattened": true + }, + "SecondaryPrivateIpAddressCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe number of secondary private IP addresses.
\n " + }, + "AssociatePublicIpAddress": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether to auto-assign a public IP address to an instance in a VPC. This public IP address can be assigned to the network interface for eth0 only when you launch the instance. You must create the network interface instead of using an existing network interface for eth0, and you must not specify more than one network interface.
\n " + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "NetworkInterface" + }, + "documentation": "\nOne or more network interfaces.
\n ", + "flattened": true + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfileSpecification", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n " + }, + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the instance profile.
\n " + } + }, + "documentation": "\nThe IAM instance profile.
\n " + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n provides dedicated throughput to Amazon EBS and an optimized\n configuration stack to provide optimal Amazon EBS I/O performance. This\n optimization isn't available with all instance types. Additional usage\n charges apply when using an EBS-optimized instance.
\nDefault: false
The ID of the reservation.
\n ", + "xmlname": "reservationId" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AWS account that owns the reservation.
\n ", + "xmlname": "ownerId" + }, + "RequesterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the requester that launched the instances on your behalf (for example,\n\t\t\t\tAWS Management Console or Auto Scaling).
\n ", + "xmlname": "requesterId" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "Instances": { + "shape_name": "InstanceList", + "type": "list", + "members": { + "shape_name": "Instance", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "ImageId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the AMI used to launch the instance.
\n ", + "xmlname": "imageId" + }, + "State": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe current state of the instance.
\n ", + "xmlname": "instanceState" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe private DNS name assigned to the instance. This DNS name can only be used\n\t\t\t\tinside the Amazon EC2 network. This name is not available until the instance enters\n\t\t\t\tthe running state.
The public DNS name assigned to the instance.\n\t\t\t\tThis name is not available until the instance enters the running state.
The reason for the most recent state transition. This might be an empty string.
\n ", + "xmlname": "reason" + }, + "KeyName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the key pair, if this instance was launched with an associated key pair.
\n ", + "xmlname": "keyName" + }, + "AmiLaunchIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe AMI launch index, which can be used to find this instance in the launch group.
\n ", + "xmlname": "amiLaunchIndex" + }, + "ProductCodes": { + "shape_name": "ProductCodeList", + "type": "list", + "members": { + "shape_name": "ProductCode", + "type": "structure", + "members": { + "ProductCodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe product code.
\n ", + "xmlname": "productCode" + }, + "ProductCodeType": { + "shape_name": "ProductCodeValues", + "type": "string", + "enum": [ + "devpay", + "marketplace" + ], + "documentation": "\nThe type of product code.
\n ", + "xmlname": "type" + } + }, + "documentation": "\nDescribes a product code.
\n ", + "xmlname": "item" + }, + "documentation": "\nThe product codes attached to this instance.
\n ", + "xmlname": "productCodes" + }, + "InstanceType": { + "shape_name": "InstanceType", + "type": "string", + "enum": [ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ], + "documentation": "\nThe instance type.
\n ", + "xmlname": "instanceType" + }, + "LaunchTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time the instance was launched.
\n ", + "xmlname": "launchTime" + }, + "Placement": { + "shape_name": "Placement", + "type": "structure", + "members": { + "AvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone of the instance.
\n ", + "xmlname": "availabilityZone" + }, + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the placement group the instance is in (for cluster compute instances).
\n ", + "xmlname": "groupName" + }, + "Tenancy": { + "shape_name": "Tenancy", + "type": "string", + "enum": [ + "default", + "dedicated" + ], + "documentation": "\nThe tenancy of the instance (if the instance is running\n in a VPC). An instance with a tenancy of dedicated runs\n on single-tenant hardware.
The location where the instance launched.
\n ", + "xmlname": "placement" + }, + "KernelId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe kernel associated with this instance.
\n ", + "xmlname": "kernelId" + }, + "RamdiskId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe RAM disk associated with this instance.
\n ", + "xmlname": "ramdiskId" + }, + "Platform": { + "shape_name": "PlatformValues", + "type": "string", + "enum": [ + "Windows" + ], + "documentation": "\nThe value is Windows for Windows instances; otherwise blank.
Indicates whether monitoring is enabled for the instance.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nThe monitoring information for the instance.
\n ", + "xmlname": "monitoring" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the subnet in which the instance is running.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the VPC in which the instance is running.
\n ", + "xmlname": "vpcId" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe private IP address assigned to the instance.
\n ", + "xmlname": "privateIpAddress" + }, + "PublicIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe public IP address assigned to the instance.
\n ", + "xmlname": "ipAddress" + }, + "StateReason": { + "shape_name": "StateReason", + "type": "structure", + "members": { + "Code": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe reason code for the state change.
\n ", + "xmlname": "code" + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe message for the state change.
\nServer.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.
Server.InternalError: An internal error occurred during instance launch, resulting in termination.
Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.
Client.InternalError: A client error caused the instance to terminate on launch.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The volume limit was exceeded.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
The reason for the most recent state transition.
\n ", + "xmlname": "stateReason" + }, + "Architecture": { + "shape_name": "ArchitectureValues", + "type": "string", + "enum": [ + "i386", + "x86_64" + ], + "documentation": "\nThe architecture of the image.
\n ", + "xmlname": "architecture" + }, + "RootDeviceType": { + "shape_name": "DeviceType", + "type": "string", + "enum": [ + "ebs", + "instance-store" + ], + "documentation": "\nThe root device type used by the AMI. The AMI can use an Amazon EBS volume\n or an instance store volume.
\n ", + "xmlname": "rootDeviceType" + }, + "RootDeviceName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe root device name (for example, /dev/sda1).
The device name exposed to the instance (for example,
The ID of the Amazon EBS volume.
\n ", + "xmlname": "volumeId" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\nThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\nThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the volume is deleted on instance termination.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\nParameters used to automatically set up Amazon EBS volumes when the instance is launched.
\n ", + "xmlname": "ebs" + } + }, + "documentation": "\nDescribes a block device mapping.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny block device mapping entries for the instance.
\n ", + "xmlname": "blockDeviceMapping" + }, + "VirtualizationType": { + "shape_name": "VirtualizationType", + "type": "string", + "enum": [ + "hvm", + "paravirtual" + ], + "documentation": "\nThe virtualization type of the instance.
\n ", + "xmlname": "virtualizationType" + }, + "InstanceLifecycle": { + "shape_name": "InstanceLifecycleType", + "type": "string", + "enum": [ + "spot" + ], + "documentation": "\nIndicates whether this is a Spot Instance.
\n ", + "xmlname": "instanceLifecycle" + }, + "SpotInstanceRequestId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the Spot Instance request.
\n ", + "xmlname": "spotInstanceRequestId" + }, + "ClientToken": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe idempotency token you provided when you launched the instance.
\n ", + "xmlname": "clientToken" + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe key of the tag.
\nConstraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode\n characters. May not begin with aws:
The value of the tag.
\nConstraints: Tag values are case-sensitive and accept a maximum of 255 Unicode\n characters.
\n ", + "xmlname": "value" + } + }, + "documentation": "\nDescribes a tag.
\n ", + "xmlname": "item" + }, + "documentation": "\nAny tags assigned to the instance.
\n ", + "xmlname": "tagSet" + }, + "SecurityGroups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more security groups for the instance.
\n ", + "xmlname": "groupSet" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether to enable an instance launched in a VPC to\n\t\t\t\tperform NAT. This controls whether source/destination checking\n\t\t\t\tis enabled on the instance. A value of true means\n\t\t\t\tchecking is enabled, and false means checking is\n\t\t\t\tdisabled. The value must be false for the instance\n\t\t\t\tto perform NAT. For more information, see NAT\n\t\t\t\tInstances in the Amazon Virtual Private Cloud User Guide.
The hypervisor type of the instance.
\n ", + "xmlname": "hypervisor" + }, + "NetworkInterfaces": { + "shape_name": "InstanceNetworkInterfaceList", + "type": "list", + "members": { + "shape_name": "InstanceNetworkInterface", + "type": "structure", + "members": { + "NetworkInterfaceId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface.
\n ", + "xmlname": "networkInterfaceId" + }, + "SubnetId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the subnet.
\n ", + "xmlname": "subnetId" + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the VPC.
\n ", + "xmlname": "vpcId" + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe description.
\n ", + "xmlname": "description" + }, + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the AWS account that created the network interface.
\n ", + "xmlname": "ownerId" + }, + "Status": { + "shape_name": "NetworkInterfaceStatus", + "type": "string", + "enum": [ + "available", + "attaching", + "in-use", + "detaching" + ], + "documentation": "\n\t\tThe status of the network interface.
\n ", + "xmlname": "status" + }, + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe IP address of the network interface within the subnet.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "SourceDestCheck": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether to validate network traffic to or from this network interface.
\n ", + "xmlname": "sourceDestCheck" + }, + "Groups": { + "shape_name": "GroupIdentifierList", + "type": "list", + "members": { + "shape_name": "GroupIdentifier", + "type": "structure", + "members": { + "GroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the security group.
\n ", + "xmlname": "groupName" + }, + "GroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the security group.
\n ", + "xmlname": "groupId" + } + }, + "documentation": "\nDescribes a security group.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tOne or more security groups.
\n ", + "xmlname": "groupSet" + }, + "Attachment": { + "shape_name": "InstanceNetworkInterfaceAttachment", + "type": "structure", + "members": { + "AttachmentId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the network interface attachment.
\n ", + "xmlname": "attachmentId" + }, + "DeviceIndex": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\n\t\tThe index of the device on the instance for the network interface attachment.
\n ", + "xmlname": "deviceIndex" + }, + "Status": { + "shape_name": "AttachmentStatus", + "type": "string", + "enum": [ + "attaching", + "attached", + "detaching", + "detached" + ], + "documentation": "\n\t\tThe attachment state.
\n ", + "xmlname": "status" + }, + "AttachTime": { + "shape_name": "DateTime", + "type": "timestamp", + "documentation": "\n\t\tThe time stamp when the attachment initiated.
\n ", + "xmlname": "attachTime" + }, + "DeleteOnTermination": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether the network interface is deleted when the instance is terminated.
\n ", + "xmlname": "deleteOnTermination" + } + }, + "documentation": "\n\t\tThe network interface attachment.
\n ", + "xmlname": "attachment" + }, + "Association": { + "shape_name": "InstanceNetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n ", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", + "xmlname": "ipOwnerId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP associated with the network interface.
\n ", + "xmlname": "association" + }, + "PrivateIpAddresses": { + "shape_name": "InstancePrivateIpAddressList", + "type": "list", + "members": { + "shape_name": "InstancePrivateIpAddress", + "type": "structure", + "members": { + "PrivateIpAddress": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private IP address of the network interface.
\n ", + "xmlname": "privateIpAddress" + }, + "PrivateDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe private DNS name.
\n ", + "xmlname": "privateDnsName" + }, + "Primary": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n\t\tIndicates whether this IP address is the primary private IP address \n\t\t of the network interface.
\n ", + "xmlname": "primary" + }, + "Association": { + "shape_name": "InstanceNetworkInterfaceAssociation", + "type": "structure", + "members": { + "PublicIp": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe address of the Elastic IP address bound to the network interface.
\n ", + "xmlname": "publicIp" + }, + "PublicDnsName": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe public DNS name.
\n ", + "xmlname": "publicDnsName" + }, + "IpOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\n\t\tThe ID of the owner of the Elastic IP address.
\n ", + "xmlname": "ipOwnerId" + } + }, + "documentation": "\n\t\tThe association information for an Elastic IP address for the network interface.
\n ", + "xmlname": "association" + } + }, + "documentation": "\n\t\tDescribes a private IP address.
\n ", + "xmlname": "item" + }, + "documentation": "\n\t\tThe private IP addresses associated with the network interface.
\n ", + "xmlname": "privateIpAddressesSet" + } + }, + "documentation": "\n\t\tDescribes a network interface.
\n ", + "xmlname": "item" + }, + "documentation": "\n[EC2-VPC] One or more network interfaces for the instance.
\n ", + "xmlname": "networkInterfaceSet" + }, + "IamInstanceProfile": { + "shape_name": "IamInstanceProfile", + "type": "structure", + "members": { + "Arn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the instance profile.
\n ", + "xmlname": "arn" + }, + "Id": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance profile.
\n ", + "xmlname": "id" + } + }, + "documentation": "\nThe IAM instance profile associated with the instance.
\n ", + "xmlname": "iamInstanceProfile" + }, + "EbsOptimized": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the instance is optimized for EBS I/O. This optimization\n\t\t\t\tprovides dedicated throughput to Amazon EBS and an optimized\n\t\t\t\tconfiguration stack to provide optimal I/O performance. This optimization\n\t\t\t\tisn't available with all instance types. Additional usage charges apply when\n\t\t\t\tusing an EBS Optimized instance.
\n ", + "xmlname": "ebsOptimized" + }, + "SriovNetSupport": { + "shape_name": "String", + "type": "string", + "documentation": "\nSpecifies whether enhanced networking is enabled.
\n ", + "xmlname": "sriovNetSupport" + } + }, + "documentation": "\nDescribes an instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nOne or more instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\nOne or more reservations.
\n ", + "xmlname": "reservation" + }, + "errors": [], + "documentation": "\nLaunches the specified number of instances using an AMI for which you have permissions.
\nWhen you launch an instance, it enters the pending state.\n After the instance is ready for you, it enters the running state.\n To check the state of your instance, call DescribeInstances.
If you don't specify a security group when launching an instance, Amazon EC2 uses\n the default security group. For more information, see Security Groups\n in the Amazon Elastic Compute Cloud User Guide.
\n\nLinux instances have access to the public key of the key pair at boot.\n You can use this key to provide secure access to the instance.\n Amazon EC2 public images use this feature to provide secure access without passwords.\n For more information, see Key Pairs\n in the Amazon Elastic Compute Cloud User Guide.
\n\nYou can provide optional user data when launching an instance. For more\n information, see Instance\n Metadata in the Amazon Elastic Compute Cloud User Guide.
\n\n\t\tIf any of the AMIs have a product code attached for which the user has not\n\t\t\tsubscribed, RunInstances fails.
T2 instance types can only be launched into a VPC. If you do not have a\n default VPC, or if you do not specify a subnet ID in the request, RunInstances\n fails.
For more information about troubleshooting, see What To Do If An\n Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the\n Amazon Elastic Compute Cloud User Guide.
\n\nami-60a54009.m1.small instance into a subnet.\n Because no network interface is specified, the default network interface is used.m1.large instance into a subnet.\n The network interface specifies a primary private IP address of 10.0.2.106\n and two secondary private IP addresses (10.0.2.107 and 10.0.2.108).m1.large instance with a block device\n mapping. There are two instance store volumes mapped to /dev/sdc and\n /dev/sdd, and a 100 GB Amazon EBS volume mapped to\n /dev/sdf.One or more instance IDs.
\n ", + "required": true, + "flattened": true + }, + "AdditionalInfo": { + "shape_name": "String", + "type": "string", + "documentation": "\nReserved.
\n " + }, + "DryRun": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\n " + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "StartInstancesResult", + "type": "structure", + "members": { + "StartingInstances": { + "shape_name": "InstanceStateChangeList", + "type": "list", + "members": { + "shape_name": "InstanceStateChange", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "CurrentState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe current state of the instance.
\n ", + "xmlname": "currentState" + }, + "PreviousState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe previous state of the instance.
\n ", + "xmlname": "previousState" + } + }, + "documentation": "\nDescribes an instance state change.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more started instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\t\tStarts an Amazon EBS-backed AMI that you've previously stopped.
\n\t\t\tInstances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time. Each time you transition an\n\t\t\t\tinstance from stopped to started, Amazon EC2 charges a full instance hour, even if\n\t\t\t\ttransitions happen multiple times within a single hour.
\n\t\t\tBefore stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.
\n\t\t\tPerforming this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.
\n\t\t\tFor more information, see Stopping Instances\n\t\t\t\tin the Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\n ", + "required": true, + "flattened": true + }, + "Force": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nForces the instances to stop. The instances do not have an\n\t\t\t\topportunity to flush file system caches or file system metadata. If you\n\t\t\t\tuse this option, you must perform file system check and repair\n\t\t\t\tprocedures. This option is not recommended for Windows\n\t\t\t instances.
\nDefault: false
The ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "CurrentState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe current state of the instance.
\n ", + "xmlname": "currentState" + }, + "PreviousState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe previous state of the instance.
\n ", + "xmlname": "previousState" + } + }, + "documentation": "\nDescribes an instance state change.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more stopped instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\t\tStops an Amazon EBS-backed instance. Each time you transition an instance from\n\t\t\t\tstopped to started, Amazon EC2 charges a full instance hour, even if transitions happen\n\t\t\t\tmultiple times within a single hour.
\n\t\t\tYou can't start or stop Spot Instances.
\n\t\t\tInstances that use Amazon EBS volumes as their root devices can be quickly stopped\n\t\t\t\tand started. When an instance is stopped, the compute resources are released and you\n\t\t\t\tare not billed for hourly instance usage. However, your root partition Amazon EBS\n\t\t\t\tvolume remains, continues to persist your data, and you are charged for Amazon EBS\n\t\t\t\tvolume usage. You can restart your instance at any time.
\n\t\t\tBefore stopping an instance, make sure it is in a state from which it can\n\t\t\t\tbe restarted. Stopping an instance does not preserve data stored in RAM.
\n\t\t\tPerforming this operation on an instance that uses an instance store as its\n\t\t\t\troot device returns an error.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
\nFor more information about troubleshooting, see Troubleshooting\n Stopping Your Instance in the\n Amazon Elastic Compute Cloud User Guide.
\nOne or more instance IDs.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "TerminateInstancesResult", + "type": "structure", + "members": { + "TerminatingInstances": { + "shape_name": "InstanceStateChangeList", + "type": "list", + "members": { + "shape_name": "InstanceStateChange", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "CurrentState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe current state of the instance.
\n ", + "xmlname": "currentState" + }, + "PreviousState": { + "shape_name": "InstanceState", + "type": "structure", + "members": { + "Code": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe low byte represents the state. The high byte is an opaque internal value and\n\t\t\t\tshould be ignored.
\n\t\t0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
The current state of the instance.
\n ", + "xmlname": "name" + } + }, + "documentation": "\nThe previous state of the instance.
\n ", + "xmlname": "previousState" + } + }, + "documentation": "\nDescribes an instance state change.
\n ", + "xmlname": "item" + }, + "documentation": "\nInformation about one or more terminated instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\t\tShuts down one or more instances. This operation is idempotent; if you terminate\n\t\t\t\tan instance more than once, each call succeeds.
\n\t\t\tTerminated instances remain visible after termination (for approximately one\n\t\t\t\thour).
\n\t\t\tBy default, Amazon EC2 deletes all Amazon EBS volumes that were attached\n\t\t\t\twhen the instance launched. Volumes attached after instance launch\n\t\t\t\tcontinue running.
\nYou can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances.\n What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance,\n the root device and any other devices attached to the instance persist. When you terminate an instance, the root\n device and any other devices attached during the instance launch are automatically deleted. For more information\n about the differences between stopping and terminating instances, see\n Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.
\nFor more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.
\nThe ID of the network interface.
\n ", + "required": true + }, + "PrivateIpAddresses": { + "shape_name": "PrivateIpAddressStringList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "PrivateIpAddress" + }, + "documentation": "\n\t\tThe secondary private IP addresses to unassign from\n\t\t\t\tthe network interface. You can specify this option multiple times to\n\t\t\t\tunassign more than one IP address.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": null, + "errors": [], + "documentation": "\n\t\tUnassigns one or more secondary private IP addresses from a network interface.
\nOne or more instance IDs.
\n ", + "required": true, + "flattened": true + } + }, + "documentation": "\n " + }, + "output": { + "shape_name": "UnmonitorInstancesResult", + "type": "structure", + "members": { + "InstanceMonitorings": { + "shape_name": "InstanceMonitoringList", + "type": "list", + "members": { + "shape_name": "InstanceMonitoring", + "type": "structure", + "members": { + "InstanceId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the instance.
\n ", + "xmlname": "instanceId" + }, + "Monitoring": { + "shape_name": "Monitoring", + "type": "structure", + "members": { + "State": { + "shape_name": "MonitoringState", + "type": "string", + "enum": [ + "disabled", + "enabled", + "pending" + ], + "documentation": "\nIndicates whether monitoring is enabled for the instance.
\n ", + "xmlname": "state" + } + }, + "documentation": "\nThe monitoring information.
\n ", + "xmlname": "monitoring" + } + }, + "documentation": "\nDescribes the monitoring information of the instance.
\n ", + "xmlname": "item" + }, + "documentation": "\nMonitoring information for one or more instances.
\n ", + "xmlname": "instancesSet" + } + }, + "documentation": "\n " + }, + "errors": [], + "documentation": "\n\t\t\tDisables monitoring for a running instance. For more information about monitoring\n\t\t\t\tinstances, see Monitoring Your\n\t\t\t\tInstances and Volumes in the Amazon Elastic Compute Cloud User Guide.
\nAmazon ElastiCache is a web service that makes it easier to set up, operate, and scale a\n distributed cache in the cloud.
\nWith ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache\n with far less of the administrative burden of launching and managing a distributed\n cache. The service makes set-up, scaling, and cluster failure handling much simpler than\n in a self-managed cache deployment.
\nIn addition, through integration with Amazon CloudWatch, customers get enhanced\n visibility into the key performance statistics associated with their cache and can\n receive alarms if a part of their cache runs hot.
\n ", + "operations": { + "AuthorizeCacheSecurityGroupIngress": { + "name": "AuthorizeCacheSecurityGroupIngress", + "input": { + "shape_name": "AuthorizeCacheSecurityGroupIngressMessage", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache security group which will allow network ingress.
\n ", + "required": true + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon EC2 security group to be authorized for ingress to the cache security\n group.
\n ", + "required": true + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of an AuthorizeCacheSecurityGroupIngress operation.
\n " + }, + "output": { + "shape_name": "CacheSecurityGroupWrapper", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape_name": "CacheSecurityGroup", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the cache security group owner.
\n " + }, + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache security group.
\n " + }, + "EC2SecurityGroups": { + "shape_name": "EC2SecurityGroupList", + "type": "list", + "members": { + "shape_name": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " + } + }, + "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", + "xmlname": "EC2SecurityGroup" + }, + "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "InvalidCacheSecurityGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " + }, + { + "shape_name": "AuthorizationAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified Amazon EC2 security group is already authorized for the specified cache\n security group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache\n security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2\n security groups are used as the authorization mechanism.
\nThe name of an existing snapshot from which to copy.
\n ", + "required": true + }, + "TargetSnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nA name for the copied snapshot.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CopySnapshotMessage operation.
\n " + }, + "output": { + "shape_name": "SnapshotWrapper", + "type": "structure", + "members": { + "Snapshot": { + "shape_name": "Snapshot", + "type": "structure", + "members": { + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " + }, + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " + }, + "SnapshotStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " + }, + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " + }, + "Port": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " + }, + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true) or not (false).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " + }, + "NodeSnapshots": { + "shape_name": "NodeSnapshotList", + "type": "list", + "members": { + "shape_name": "NodeSnapshot", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " + }, + "CacheSize": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe size of the cache on the source cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " + }, + "SnapshotCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", + "xmlname": "NodeSnapshot" + }, + "documentation": "\nA list of the cache nodes in the source cache cluster.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " + } + } + }, + "errors": [ + { + "shape_name": "SnapshotAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a snapshot with the given name.
\n " + }, + { + "shape_name": "SnapshotNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " + }, + { + "shape_name": "SnapshotQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " + }, + { + "shape_name": "InvalidSnapshotStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the snapshot does not allow the requested action to occur.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe CopySnapshot operation makes a copy of an existing snapshot.
\n " + }, + "CreateCacheCluster": { + "name": "CreateCacheCluster", + "input": { + "shape_name": "CreateCacheClusterMessage", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster identifier. This parameter is stored as a lowercase string.
\n \nConstraints:
\nThe replication group to which this cache cluster should belong. If this parameter is\n specified, the cache cluster will be added to the specified replication group as a read\n replica; otherwise, the cache cluster will be a standalone primary that is not part of\n any replication group.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe initial number of cache nodes that the cache cluster will have.
\nFor a Memcached cluster, valid values are between 1 and 20. If you need to exceed this\n limit, please fill out the ElastiCache Limit Increase Request form at .
\nFor Redis, only single-node cache clusters are supported at this time, so the value for\n this parameter must be 1.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe compute and memory capacity of the nodes in the cache cluster.
\n \nValid cache types
\ncache.t1.micro | cache.m1.small
cache.m3.medium | cache.m3.large | cache.m3.xlarge | cache.m3.2xlarge
cache.m1.medium | cache.m1.large | cache.m1.xlarge
cache.c1.xlarge
cache.r3.large | cache.r3.xlarge | cache.r3.2xlarge | cache.r3.4xlarge | cache.r3.8xlarge
cache.m2.xlarge | cache.m2.2xlarge | cache.m2.4xlarge
For a complete listing of cache node types and specifications, \nsee Cache Node Type-Specific Parameters for Memcached\nor Cache Node Type-Specific Parameters for Redis \nand Amazon ElastiCache Product Features and Details.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine to be used for this cache cluster.
\nValid values for this parameter are:
\nmemcached | redis
The version number of the cache engine to be used for this cluster. To view the supported\n cache engine versions, use the DescribeCacheEngineVersions operation.
\n " + }, + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group to associate with this cache cluster. If this\n argument is omitted, the default cache parameter group for the specified engine will be\n used.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group to be used for the cache cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\n " + }, + "CacheSecurityGroupNames": { + "shape_name": "CacheSecurityGroupNameList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheSecurityGroupName" + }, + "documentation": "\nA list of cache security group names to associate with this cache cluster.
\nUse this parameter only when you are creating a cluster outside of an Amazon Virtual\n Private Cloud (VPC).
\n " + }, + "SecurityGroupIds": { + "shape_name": "SecurityGroupIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\nOne or more VPC security groups associated with the cache cluster.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\n " + }, + "SnapshotArns": { + "shape_name": "SnapshotArnsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SnapshotArn" + }, + "documentation": "\nA single-element string list containing an Amazon Resource Name (ARN) that uniquely\n identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used\n to populate the Redis cache in the new cache cluster. The Amazon S3 object name in the\n ARN cannot contain any commas.
\n\nHere is an example of an Amazon S3 ARN:\n arn:aws:s3:::my_bucket/snapshot1.rdb
Note: This parameter is only valid if the Engine parameter is\n redis.
The name of a snapshot from which to restore data into the new cache cluster. The\n snapshot's status changes to restoring while the new cache cluster is being\n created.
Specifies whether the nodes in this Memcached cache cluster are created in a single Availability Zone or \n created across multiple Availability Zones.
\nThis option is only supported for Memcached cache clusters.
\nAZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.Valid values: single-az | cross-az.
The EC2 Availability Zone in which the cache cluster will be created.
\nAll cache nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. \n If you want to create your cache nodes across multiple Availability Zones, use PreferredAvailabilityZones.
Default: System chosen Availability Zone.
\n " + }, + "PreferredAvailabilityZones": { + "shape_name": "PreferredAvailabilityZoneList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "PreferredAvailabilityZone" + }, + "documentation": "\nA list of the Availability Zones in which nodes will be created. The order of the zones in the list is not important.
\nThis option is only supported on Memcached clusters.
\nIf you are creating your cache cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones \n that are associated with the subnets in the selected subnet group.
\nThe number of Availability Zones listed must equal the value of NumCacheNodes.
If you want all your cache nodes in the same Availability Zone, use PreferredAvailabilityZone instead or \n repeat the Availability Zone multiple times in the list.
Default: System chosen Availability Zones.
\nExample: One Memcached node in each of three Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d
Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a
The weekly time range (in UTC) during which system maintenance can occur.
\nExample: sun:05:00-sun:09:00\n
The port number on which each of the cache nodes will accept connections.
\n " + }, + "NotificationTopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to\n which notifications will be sent.
\nDetermines whether minor engine upgrades will be applied automatically to the cache\n cluster during the maintenance window. A value of true allows these\n upgrades to occur; false disables automatic upgrades.
Default: true
The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
If you do not specify this parameter, then SnapshotRetentionLimit will be set to 0 (i.e., automatic backups will be disabled for this cache cluster).
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
\n " + } + }, + "documentation": "\nRepresents the input of a CreateCacheCluster operation.
\n " + }, + "output": { + "shape_name": "CacheClusterWrapper", + "type": "structure", + "members": { + "CacheCluster": { + "shape_name": "CacheCluster", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " + }, + "ConfigurationEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "ClientDownloadLandingPage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " + }, + "CacheClusterStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " + }, + "PendingModifiedValues": { + "shape_name": "PendingModifiedValues", + "type": "structure", + "members": { + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " + }, + "CacheNodeIdsToRemove": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " + } + }, + "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " + }, + "NotificationConfiguration": { + "shape_name": "NotificationConfiguration", + "type": "structure", + "members": { + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " + }, + "TopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of the topic.
\n " + } + }, + "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroupMembershipList", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroupMembership", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", + "xmlname": "CacheSecurityGroup" + }, + "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " + }, + "CacheParameterGroup": { + "shape_name": "CacheParameterGroupStatus", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "ParameterApplyStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of parameter updates.
\n " + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + } + }, + "documentation": "\nThe status of the cache parameter group.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " + }, + "CacheNodes": { + "shape_name": "CacheNodeList", + "type": "list", + "members": { + "shape_name": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " + }, + "CacheNodeStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created.
\n " + }, + "Endpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " + }, + "ParameterGroupStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the parameter group applied to this cache node.
\n " + }, + "SourceCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " + }, + "CustomerAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where this node was created and now resides.
\n " + } + }, + "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", + "xmlname": "CacheNode" + }, + "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a single cache security group and its status..
\n " + }, + "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " + }, + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " + } + } + }, + "errors": [ + { + "shape_name": "ReplicationGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified replication group does not exist.
\n " + }, + { + "shape_name": "InvalidReplicationGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested replication group is not in the available state.
\n " + }, + { + "shape_name": "CacheClusterAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a cache cluster with the given identifier.
\n " + }, + { + "shape_name": "InsufficientCacheClusterCapacityFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache node type is not available in the specified Availability Zone.
\n " + }, + { + "shape_name": "CacheSecurityGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "CacheSubnetGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " + }, + { + "shape_name": "ClusterQuotaForCustomerExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n clusters per customer.
\n " + }, + { + "shape_name": "NodeQuotaForClusterExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.
\n " + }, + { + "shape_name": "NodeQuotaForCustomerExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n per customer.
\n " + }, + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidVPCNetworkStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe VPC network is in an invalid state.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe CreateCacheCluster operation creates a new cache cluster. All nodes in the\n cache cluster run the same protocol-compliant cache engine software - either Memcached\n or Redis.
\nA user-specified name for the cache parameter group.
\n ", + "required": true + }, + "CacheParameterGroupFamily": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group family the cache parameter group can be used\n with.
\nValid values are: memcached1.4 | redis2.6 |\n redis2.8
A user-specified description for the cache parameter group.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CreateCacheParameterGroup operation.
\n " + }, + "output": { + "shape_name": "CacheParameterGroupWrapper", + "type": "structure", + "members": { + "CacheParameterGroup": { + "shape_name": "CacheParameterGroup", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "CacheParameterGroupFamily": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group family that this cache parameter group is\n compatible with.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for this cache parameter group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of a CreateCacheParameterGroup operation.
\n " + } + } + }, + "errors": [ + { + "shape_name": "CacheParameterGroupQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the maximum number of cache\n security groups.
\n " + }, + { + "shape_name": "CacheParameterGroupAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nA cache parameter group with the requested name already exists.
\n " + }, + { + "shape_name": "InvalidCacheParameterGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe CreateCacheParameterGroup operation creates a new cache parameter group. A\n cache parameter group is a collection of parameters that you apply to all of the nodes\n in a cache cluster.
\nA name for the cache security group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be the word\n \"Default\".
\nExample: mysecuritygroup
A description for the cache security group.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CreateCacheSecurityGroup operation.
\n " + }, + "output": { + "shape_name": "CacheSecurityGroupWrapper", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape_name": "CacheSecurityGroup", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the cache security group owner.
\n " + }, + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache security group.
\n " + }, + "EC2SecurityGroups": { + "shape_name": "EC2SecurityGroupList", + "type": "list", + "members": { + "shape_name": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " + } + }, + "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", + "xmlname": "EC2SecurityGroup" + }, + "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nA cache security group with the specified name already exists.
\n " + }, + { + "shape_name": "CacheSecurityGroupQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n security groups.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe CreateCacheSecurityGroup operation creates a new cache security group. Use a\n cache security group to control access to one or more cache clusters.
\nCache security groups are only used when you are creating a cluster outside of an Amazon\n Virtual Private Cloud (VPC). If you are creating a cluster inside of a VPC, use a cache\n subnet group instead. For more information, see CreateCacheSubnetGroup.
\nA name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
A description for the cache subnet group.
\n ", + "required": true + }, + "SubnetIds": { + "shape_name": "SubnetIdentifierList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SubnetIdentifier" + }, + "documentation": "\nA list of VPC subnet IDs for the cache subnet group.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CreateCacheSubnetGroup operation.
\n " + }, + "output": { + "shape_name": "CacheSubnetGroupWrapper", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape_name": "CacheSubnetGroup", + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group.
\n " + }, + "CacheSubnetGroupDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache subnet group.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " + }, + "Subnets": { + "shape_name": "SubnetList", + "type": "list", + "members": { + "shape_name": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe unique identifier for the subnet
\n " + }, + "SubnetAvailabilityZone": { + "shape_name": "AvailabilityZone", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone.
\n " + } + }, + "wrapper": true, + "documentation": "\nThe Availability Zone associated with the subnet
\n " + } + }, + "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", + "xmlname": "Subnet" + }, + "documentation": "\nA list of subnets associated with the cache subnet group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache subnet group name is already in use by an existing cache subnet\n group.
\n " + }, + { + "shape_name": "CacheSubnetGroupQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache\n subnet groups.
\n " + }, + { + "shape_name": "CacheSubnetQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.
\n " + }, + { + "shape_name": "InvalidSubnet", + "type": "structure", + "members": {}, + "documentation": "\nAn invalid subnet identifier was specified.
\n " + } + ], + "documentation": "\nThe CreateCacheSubnetGroup operation creates a new cache subnet group.
\nUse this parameter only when you are creating a cluster in an Amazon Virtual Private\n Cloud (VPC).
\nThe replication group identifier. This parameter is stored as a lowercase string.
\n \nConstraints:
\nThe identifier of the cache cluster that will serve as the primary for this replication\n group. This cache cluster must already exist and have a status of available.
\n ", + "required": true + }, + "ReplicationGroupDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nA user-specified description for the replication group.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CreateReplicationGroup operation.
\n " + }, + "output": { + "shape_name": "ReplicationGroupWrapper", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape_name": "ReplicationGroup", + "type": "structure", + "members": { + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the replication group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the replication group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PendingModifiedValues": { + "shape_name": "ReplicationGroupPendingModifiedValues", + "type": "structure", + "members": { + "PrimaryClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " + }, + "MemberClusters": { + "shape_name": "ClusterIdList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ClusterId" + }, + "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " + }, + "NodeGroups": { + "shape_name": "NodeGroupList", + "type": "list", + "members": { + "shape_name": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PrimaryEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "NodeGroupMembers": { + "shape_name": "NodeGroupMemberList", + "type": "list", + "members": { + "shape_name": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " + }, + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " + }, + "ReadEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " + }, + "CurrentRole": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " + } + }, + "documentation": "\nRepresents a single node within a node group.
\n ", + "xmlname": "NodeGroupMember" + }, + "documentation": "\nA list containing information about individual nodes within the node group.
\n " + } + }, + "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", + "xmlname": "NodeGroup" + }, + "documentation": "\nA single element list with information about the nodes in the replication group.
\n " + }, + "SnapshottingClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains all of the attributes of a specific replication group.
\n " + } + } + }, + "errors": [ + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "ReplicationGroupAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified replication group already exists.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe CreateReplicationGroup operation creates a replication group. A replication\n group is a collection of cache clusters, where one of the clusters is a read/write\n primary and the other clusters are read-only replicas. Writes to the primary are\n automatically propagated to the replicas.
\nWhen you create a replication group, you must specify an existing cache cluster that is\n in the primary role. When the replication group has been successfully created, you can\n add one or more read replica replicas to it, up to a total of five read replicas.
\nThe identifier of an existing cache cluster. The snapshot will be created from this cache\n cluster.
\n ", + "required": true + }, + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nA name for the snapshot being created.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a CreateSnapshotMessage operation.
\n " + }, + "output": { + "shape_name": "SnapshotWrapper", + "type": "structure", + "members": { + "Snapshot": { + "shape_name": "Snapshot", + "type": "structure", + "members": { + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " + }, + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " + }, + "SnapshotStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " + }, + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " + }, + "Port": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " + }, + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true) or not (false).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " + }, + "NodeSnapshots": { + "shape_name": "NodeSnapshotList", + "type": "list", + "members": { + "shape_name": "NodeSnapshot", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " + }, + "CacheSize": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe size of the cache on the source cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " + }, + "SnapshotCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", + "xmlname": "NodeSnapshot" + }, + "documentation": "\nA list of the cache nodes in the source cache cluster.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " + } + } + }, + "errors": [ + { + "shape_name": "SnapshotAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a snapshot with the given name.
\n " + }, + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "SnapshotQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " + }, + { + "shape_name": "SnapshotFeatureNotSupportedFault", + "type": "structure", + "members": {}, + "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + } + ], + "documentation": "\nThe CreateSnapshot operation creates a copy of an entire cache cluster at a\n specific moment in time.
\nThe cache cluster identifier for the cluster to be deleted. This parameter is not case\n sensitive.
\n ", + "required": true + }, + "FinalSnapshotIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a final cache cluster snapshot. ElastiCache creates the snapshot, and then deletes\n the cache cluster immediately afterward.
\n " + } + }, + "documentation": "\nRepresents the input of a DeleteCacheCluster operation.
\n " + }, + "output": { + "shape_name": "CacheClusterWrapper", + "type": "structure", + "members": { + "CacheCluster": { + "shape_name": "CacheCluster", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " + }, + "ConfigurationEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "ClientDownloadLandingPage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " + }, + "CacheClusterStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " + }, + "PendingModifiedValues": { + "shape_name": "PendingModifiedValues", + "type": "structure", + "members": { + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " + }, + "CacheNodeIdsToRemove": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " + } + }, + "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " + }, + "NotificationConfiguration": { + "shape_name": "NotificationConfiguration", + "type": "structure", + "members": { + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " + }, + "TopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of the topic.
\n " + } + }, + "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroupMembershipList", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroupMembership", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", + "xmlname": "CacheSecurityGroup" + }, + "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " + }, + "CacheParameterGroup": { + "shape_name": "CacheParameterGroupStatus", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "ParameterApplyStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of parameter updates.
\n " + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + } + }, + "documentation": "\nThe status of the cache parameter group.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " + }, + "CacheNodes": { + "shape_name": "CacheNodeList", + "type": "list", + "members": { + "shape_name": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " + }, + "CacheNodeStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created.
\n " + }, + "Endpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " + }, + "ParameterGroupStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the parameter group applied to this cache node.
\n " + }, + "SourceCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " + }, + "CustomerAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where this node was created and now resides.
\n " + } + }, + "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", + "xmlname": "CacheNode" + }, + "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a single cache security group and its status..
\n " + }, + "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " + }, + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " + } + } + }, + "errors": [ + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "SnapshotAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a snapshot with the given name.
\n " + }, + { + "shape_name": "SnapshotFeatureNotSupportedFault", + "type": "structure", + "members": {}, + "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " + }, + { + "shape_name": "SnapshotQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DeleteCacheCluster operation deletes a previously provisioned cache cluster.\n DeleteCacheCluster deletes all associated cache nodes, node endpoints and the\n cache cluster itself. When you receive a successful response from this operation,\n Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert\n this operation.
\nThe name of the cache parameter group to delete.
\nRepresents the input of a DeleteCacheParameterGroup operation.
\n " + }, + "output": null, + "errors": [ + { + "shape_name": "InvalidCacheParameterGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " + }, + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DeleteCacheParameterGroup operation deletes the specified cache parameter\n group. You cannot delete a cache parameter group if it is associated with any cache\n clusters.
\nThe name of the cache security group to delete.
\nRepresents the input of a DeleteCacheSecurityGroup operation.
\n " + }, + "output": null, + "errors": [ + { + "shape_name": "InvalidCacheSecurityGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " + }, + { + "shape_name": "CacheSecurityGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DeleteCacheSecurityGroup operation deletes a cache security group.
\nThe name of the cache subnet group to delete.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a DeleteCacheSubnetGroup operation.
\n " + }, + "output": null, + "errors": [ + { + "shape_name": "CacheSubnetGroupInUse", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache subnet group is currently in use.
\n " + }, + { + "shape_name": "CacheSubnetGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " + } + ], + "documentation": "\nThe DeleteCacheSubnetGroup operation deletes a cache subnet group.
\nThe identifier for the replication group to be deleted. This parameter is not case\n sensitive.
\n ", + "required": true + }, + "RetainPrimaryCluster": { + "shape_name": "BooleanOptional", + "type": "boolean", + "documentation": "\nIf set to true, all of the read replicas will be deleted, but the primary cache\n cluster will be retained.
\n " + }, + "FinalSnapshotIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a final cache cluster snapshot. ElastiCache creates the snapshot from the primary cluster in the replication group, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is deleted immediately afterward.
\n " + } + }, + "documentation": "\nRepresents the input of a DeleteReplicationGroup operation.
\n " + }, + "output": { + "shape_name": "ReplicationGroupWrapper", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape_name": "ReplicationGroup", + "type": "structure", + "members": { + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the replication group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the replication group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PendingModifiedValues": { + "shape_name": "ReplicationGroupPendingModifiedValues", + "type": "structure", + "members": { + "PrimaryClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " + }, + "MemberClusters": { + "shape_name": "ClusterIdList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ClusterId" + }, + "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " + }, + "NodeGroups": { + "shape_name": "NodeGroupList", + "type": "list", + "members": { + "shape_name": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PrimaryEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "NodeGroupMembers": { + "shape_name": "NodeGroupMemberList", + "type": "list", + "members": { + "shape_name": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " + }, + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " + }, + "ReadEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " + }, + "CurrentRole": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " + } + }, + "documentation": "\nRepresents a single node within a node group.
\n ", + "xmlname": "NodeGroupMember" + }, + "documentation": "\nA list containing information about individual nodes within the node group.
\n " + } + }, + "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", + "xmlname": "NodeGroup" + }, + "documentation": "\nA single element list with information about the nodes in the replication group.
\n " + }, + "SnapshottingClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains all of the attributes of a specific replication group.
\n " + } + } + }, + "errors": [ + { + "shape_name": "ReplicationGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified replication group does not exist.
\n " + }, + { + "shape_name": "InvalidReplicationGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested replication group is not in the available state.
\n " + }, + { + "shape_name": "SnapshotAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a snapshot with the given name.
\n " + }, + { + "shape_name": "SnapshotFeatureNotSupportedFault", + "type": "structure", + "members": {}, + "documentation": "\nYou attempted one of the following actions:
\nCreating a snapshot of a Redis cache cluster running on a a t1.micro cache\n node.
\nCreating a snapshot of a cache cluster that is running Memcached rather than\n Redis.
\nNeither of these are supported by ElastiCache.
\n " + }, + { + "shape_name": "SnapshotQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the maximum number of\n snapshots.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DeleteReplicationGroup operation deletes an existing replication group. By\n default, this operation deletes the entire replication group, including the primary\n cache cluster and all of the read replicas. You can optionally delete only the read\n replicas, while retaining the primary cache cluster.
\nWhen you receive a successful response from this operation, Amazon ElastiCache immediately begins\n deleting the selected resources; you cannot cancel or revert this operation.
\nThe name of the snapshot to be deleted.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a DeleteSnapshotMessage operation.
\n " + }, + "output": { + "shape_name": "SnapshotWrapper", + "type": "structure", + "members": { + "Snapshot": { + "shape_name": "Snapshot", + "type": "structure", + "members": { + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " + }, + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " + }, + "SnapshotStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " + }, + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " + }, + "Port": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " + }, + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true) or not (false).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " + }, + "NodeSnapshots": { + "shape_name": "NodeSnapshotList", + "type": "list", + "members": { + "shape_name": "NodeSnapshot", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " + }, + "CacheSize": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe size of the cache on the source cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " + }, + "SnapshotCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", + "xmlname": "NodeSnapshot" + }, + "documentation": "\nA list of the cache nodes in the source cache cluster.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n " + } + } + }, + "errors": [ + { + "shape_name": "SnapshotNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " + }, + { + "shape_name": "InvalidSnapshotStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the snapshot does not allow the requested action to occur.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DeleteSnapshot operation deletes an existing snapshot. When you receive a\n successful response from this operation, ElastiCache immediately begins deleting the snapshot;\n you cannot cancel or revert this operation.
\nThe user-supplied cluster identifier. If this parameter is specified, only information\n about that specific cache cluster is returned. This parameter isn't case sensitive.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
" + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + }, + "ShowCacheNodeInfo": { + "shape_name": "BooleanOptional", + "type": "boolean", + "documentation": "\nAn optional flag that can be included in the DescribeCacheCluster request to retrieve\n information about the individual cache nodes.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheClusters operation.
\n " + }, + "output": { + "shape_name": "CacheClusterMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "CacheClusters": { + "shape_name": "CacheClusterList", + "type": "list", + "members": { + "shape_name": "CacheCluster", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " + }, + "ConfigurationEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "ClientDownloadLandingPage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " + }, + "CacheClusterStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " + }, + "PendingModifiedValues": { + "shape_name": "PendingModifiedValues", + "type": "structure", + "members": { + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " + }, + "CacheNodeIdsToRemove": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " + } + }, + "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " + }, + "NotificationConfiguration": { + "shape_name": "NotificationConfiguration", + "type": "structure", + "members": { + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " + }, + "TopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of the topic.
\n " + } + }, + "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroupMembershipList", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroupMembership", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", + "xmlname": "CacheSecurityGroup" + }, + "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " + }, + "CacheParameterGroup": { + "shape_name": "CacheParameterGroupStatus", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "ParameterApplyStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of parameter updates.
\n " + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + } + }, + "documentation": "\nThe status of the cache parameter group.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " + }, + "CacheNodes": { + "shape_name": "CacheNodeList", + "type": "list", + "members": { + "shape_name": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " + }, + "CacheNodeStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created.
\n " + }, + "Endpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " + }, + "ParameterGroupStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the parameter group applied to this cache node.
\n " + }, + "SourceCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " + }, + "CustomerAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where this node was created and now resides.
\n " + } + }, + "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", + "xmlname": "CacheNode" + }, + "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a single cache security group and its status..
\n " + }, + "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " + }, + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n ", + "xmlname": "CacheCluster" + }, + "documentation": "\nA list of cache clusters. Each item in the list contains detailed information about one\n cache cluster.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheClusters operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeCacheClusters operation returns information about all provisioned\n cache clusters if no cache cluster identifier is specified, or about a specific cache\n cluster if a cache cluster identifier is supplied.
\nBy default, abbreviated information about the cache clusters(s) will be returned. You can\n use the optional ShowDetails flag to retrieve detailed information about the\n cache nodes associated with the cache clusters. These details include the DNS address\n and port for the cache node endpoint.
\nIf the cluster is in the CREATING state, only cluster level information will be displayed\n until all of the nodes are successfully provisioned.
\nIf the cluster is in the DELETING state, only cluster level information will be\n displayed.
\nIf cache nodes are currently being added to the cache cluster, node endpoint information\n and creation time for the additional nodes will not be displayed until they are\n completely provisioned. When the cache cluster state is available, the cluster is\n ready for use.
\nIf cache nodes are currently being removed from the cache cluster, no endpoint\n information for the removed nodes is displayed.
\n\nThe cache engine to return. Valid values: memcached | redis
The cache engine version to return.
\nExample: 1.4.14
The name of a specific cache parameter group family to return details for.
\nConstraints:
\nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + }, + "DefaultOnly": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, specifies that only the default version of the specified engine or engine\n and major version combination is to be returned.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheEngineVersions operation.
\n " + }, + "output": { + "shape_name": "CacheEngineVersionMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "CacheEngineVersions": { + "shape_name": "CacheEngineVersionList", + "type": "list", + "members": { + "shape_name": "CacheEngineVersion", + "type": "structure", + "members": { + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version number of the cache engine.
\n " + }, + "CacheParameterGroupFamily": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group family associated with this cache engine.
\n " + }, + "CacheEngineDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache engine.
\n " + }, + "CacheEngineVersionDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache engine version.
\n " + } + }, + "documentation": "\nProvides all of the details about a particular cache engine version.
\n ", + "xmlname": "CacheEngineVersion" + }, + "documentation": "\nA list of cache engine version details. Each element in the list contains detailed\n information about once cache engine version.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheEngineVersions operation.
\n " + }, + "errors": [], + "documentation": "\nThe DescribeCacheEngineVersions operation returns a list of the available cache\n engines and their versions.
\nThe name of a specific cache parameter group to return details for.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheParameterGroups operation.
\n " + }, + "output": { + "shape_name": "CacheParameterGroupsMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "CacheParameterGroups": { + "shape_name": "CacheParameterGroupList", + "type": "list", + "members": { + "shape_name": "CacheParameterGroup", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "CacheParameterGroupFamily": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group family that this cache parameter group is\n compatible with.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description for this cache parameter group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of a CreateCacheParameterGroup operation.
\n ", + "xmlname": "CacheParameterGroup" + }, + "documentation": "\nA list of cache parameter groups. Each element in the list contains detailed information\n about one cache parameter group.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheParameterGroups operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeCacheParameterGroups operation returns a list of cache parameter group\n descriptions. If a cache parameter group name is specified, the list will contain only\n the descriptions for that group.
\nThe name of a specific cache parameter group to return details for.
\n ", + "required": true + }, + "Source": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe parameter types to return.
\nValid values: user | system | engine-default\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheParameters operation.
\n " + }, + "output": { + "shape_name": "CacheParameterGroupDetails", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "Parameters": { + "shape_name": "ParametersList", + "type": "list", + "members": { + "shape_name": "Parameter", + "type": "structure", + "members": { + "ParameterName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the parameter.
\n " + }, + "ParameterValue": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value of the parameter.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the parameter.
\n " + }, + "Source": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe source of the parameter.
\n " + }, + "DataType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid data type for the parameter.
\n " + }, + "AllowedValues": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid range of values for the parameter.
\n " + }, + "IsModifiable": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " + } + }, + "documentation": "\nDescribes an individual setting that controls some aspect of ElastiCache behavior.
\n ", + "xmlname": "Parameter" + }, + "documentation": "\nA list of Parameter instances.
\n " + }, + "CacheNodeTypeSpecificParameters": { + "shape_name": "CacheNodeTypeSpecificParametersList", + "type": "list", + "members": { + "shape_name": "CacheNodeTypeSpecificParameter", + "type": "structure", + "members": { + "ParameterName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the parameter.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the parameter.
\n " + }, + "Source": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe source of the parameter value.
\n " + }, + "DataType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid data type for the parameter.
\n " + }, + "AllowedValues": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid range of values for the parameter.
\n " + }, + "IsModifiable": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " + }, + "CacheNodeTypeSpecificValues": { + "shape_name": "CacheNodeTypeSpecificValueList", + "type": "list", + "members": { + "shape_name": "CacheNodeTypeSpecificValue", + "type": "structure", + "members": { + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type for which this value applies.
\n " + }, + "Value": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value for the cache node type.
\n " + } + }, + "documentation": "\nA value that applies only to a certain cache node type.
\n ", + "xmlname": "CacheNodeTypeSpecificValue" + }, + "documentation": "\nA list of cache node types and their corresponding values for this parameter.
\n " + } + }, + "documentation": "\nA parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.
\n ", + "xmlname": "CacheNodeTypeSpecificParameter" + }, + "documentation": "\nA list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheParameters operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeCacheParameters operation returns the detailed parameter list for a\n particular cache parameter group.
\nThe name of the cache security group to return details for.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheSecurityGroups operation.
\n " + }, + "output": { + "shape_name": "CacheSecurityGroupMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroups", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroup", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the cache security group owner.
\n " + }, + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache security group.
\n " + }, + "EC2SecurityGroups": { + "shape_name": "EC2SecurityGroupList", + "type": "list", + "members": { + "shape_name": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " + } + }, + "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", + "xmlname": "EC2SecurityGroup" + }, + "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nA list of cache security groups. Each element in the list contains detailed information\n about one group.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheSecurityGroups operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheSecurityGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeCacheSecurityGroups operation returns a list of cache security group\n descriptions. If a cache security group name is specified, the list will contain only\n the description of that group.
\nThe name of the cache subnet group to return details for.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeCacheSubnetGroups operation.
\n " + }, + "output": { + "shape_name": "CacheSubnetGroupMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "CacheSubnetGroups": { + "shape_name": "CacheSubnetGroups", + "type": "list", + "members": { + "shape_name": "CacheSubnetGroup", + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group.
\n " + }, + "CacheSubnetGroupDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache subnet group.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " + }, + "Subnets": { + "shape_name": "SubnetList", + "type": "list", + "members": { + "shape_name": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe unique identifier for the subnet
\n " + }, + "SubnetAvailabilityZone": { + "shape_name": "AvailabilityZone", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone.
\n " + } + }, + "wrapper": true, + "documentation": "\nThe Availability Zone associated with the subnet
\n " + } + }, + "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", + "xmlname": "Subnet" + }, + "documentation": "\nA list of subnets associated with the cache subnet group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nA list of cache subnet groups. Each element in the list contains detailed information\n about one group.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeCacheSubnetGroups operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheSubnetGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " + } + ], + "documentation": "\nThe DescribeCacheSubnetGroups operation returns a list of cache subnet group\n descriptions. If a subnet group name is specified, the list will contain only the\n description of that group.
\nThe name of the cache parameter group family. Valid values are: memcached1.4\n | redis2.6 | redis2.8
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeEngineDefaultParameters operation.
\n " + }, + "output": { + "shape_name": "EngineDefaultsWrapper", + "type": "structure", + "members": { + "EngineDefaults": { + "shape_name": "EngineDefaults", + "type": "structure", + "members": { + "CacheParameterGroupFamily": { + "shape_name": "String", + "type": "string", + "documentation": "\nSpecifies the name of the cache parameter group family to which the engine default\n parameters apply.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "Parameters": { + "shape_name": "ParametersList", + "type": "list", + "members": { + "shape_name": "Parameter", + "type": "structure", + "members": { + "ParameterName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the parameter.
\n " + }, + "ParameterValue": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value of the parameter.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the parameter.
\n " + }, + "Source": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe source of the parameter.
\n " + }, + "DataType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid data type for the parameter.
\n " + }, + "AllowedValues": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid range of values for the parameter.
\n " + }, + "IsModifiable": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " + } + }, + "documentation": "\nDescribes an individual setting that controls some aspect of ElastiCache behavior.
\n ", + "xmlname": "Parameter" + }, + "documentation": "\nContains a list of engine default parameters.
\n " + }, + "CacheNodeTypeSpecificParameters": { + "shape_name": "CacheNodeTypeSpecificParametersList", + "type": "list", + "members": { + "shape_name": "CacheNodeTypeSpecificParameter", + "type": "structure", + "members": { + "ParameterName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the parameter.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description of the parameter.
\n " + }, + "Source": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe source of the parameter value.
\n " + }, + "DataType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid data type for the parameter.
\n " + }, + "AllowedValues": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe valid range of values for the parameter.
\n " + }, + "IsModifiable": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether (true) or not (false) the parameter can be\n modified. Some parameters have security or operational implications that prevent them\n from being changed.
The earliest cache engine version to which the parameter can apply.
\n " + }, + "CacheNodeTypeSpecificValues": { + "shape_name": "CacheNodeTypeSpecificValueList", + "type": "list", + "members": { + "shape_name": "CacheNodeTypeSpecificValue", + "type": "structure", + "members": { + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type for which this value applies.
\n " + }, + "Value": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value for the cache node type.
\n " + } + }, + "documentation": "\nA value that applies only to a certain cache node type.
\n ", + "xmlname": "CacheNodeTypeSpecificValue" + }, + "documentation": "\nA list of cache node types and their corresponding values for this parameter.
\n " + } + }, + "documentation": "\nA parameter that has a different value for each cache node type it is applied to. For\n example, in a Redis cache cluster, a cache.m1.large cache node type would have a\n larger maxmemory value than a cache.m1.small type.
\n ", + "xmlname": "CacheNodeTypeSpecificParameter" + }, + "documentation": "\nA list of parameters specific to a particular cache node type. Each element in the list\n contains detailed information about one parameter.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of a DescribeEngineDefaultParameters operation.
\n " + } + } + }, + "errors": [ + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeEngineDefaultParameters operation returns the default engine and\n system parameter information for the specified cache engine.
\nThe identifier of the event source for which events will be returned. If not specified,\n then all sources are included in the response.
\n " + }, + "SourceType": { + "shape_name": "SourceType", + "type": "string", + "enum": [ + "cache-cluster", + "cache-parameter-group", + "cache-security-group", + "cache-subnet-group" + ], + "documentation": "\nThe event source to retrieve events for. If no value is specified, all events are\n returned.
\nValid values are: cache-cluster | cache-parameter-group |\n cache-security-group | cache-subnet-group
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.\n
\n " + }, + "EndTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe end of the time interval for which to retrieve events, specified in ISO 8601 format.\n
\n " + }, + "Duration": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of minutes' worth of events to retrieve.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": " \n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeEvents operation.
\n " + }, + "output": { + "shape_name": "EventsMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "Events": { + "shape_name": "EventList", + "type": "list", + "members": { + "shape_name": "Event", + "type": "structure", + "members": { + "SourceIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the source of the event. For example, if the event occurred at the\n cache cluster level, the identifier would be the name of the cache cluster.
\n " + }, + "SourceType": { + "shape_name": "SourceType", + "type": "string", + "enum": [ + "cache-cluster", + "cache-parameter-group", + "cache-security-group", + "cache-subnet-group" + ], + "documentation": "\nSpecifies the origin of this event - a cache cluster, a parameter group, a security\n group, etc.
\n " + }, + "Message": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe text of the event.
\n " + }, + "Date": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the event occurred.
\n " + } + }, + "documentation": "\nRepresents a single occurrence of something interesting within the system. Some examples\n of events are creating a cache cluster, adding or removing a cache node, or rebooting a\n node.
\n ", + "xmlname": "Event" + }, + "documentation": "\nA list of events. Each element in the list contains detailed information about one\n event.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeEvents operation.
\n " + }, + "errors": [ + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeEvents operation returns events related to cache clusters, cache\n security groups, and cache parameter groups. You can obtain events specific to a\n particular cache cluster, cache security group, or cache parameter group by providing\n the name as a parameter.
\nBy default, only the events occurring within the last hour are returned; however, you can\n retrieve up to 14 days' worth of events if necessary.
\nThe identifier for the replication group to be described. This parameter is not case\n sensitive.
\nIf you do not specify this parameter, information about all replication groups is\n returned.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeReplicationGroups operation.
\n " + }, + "output": { + "shape_name": "ReplicationGroupMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "ReplicationGroups": { + "shape_name": "ReplicationGroupList", + "type": "list", + "members": { + "shape_name": "ReplicationGroup", + "type": "structure", + "members": { + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the replication group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the replication group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PendingModifiedValues": { + "shape_name": "ReplicationGroupPendingModifiedValues", + "type": "structure", + "members": { + "PrimaryClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " + }, + "MemberClusters": { + "shape_name": "ClusterIdList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ClusterId" + }, + "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " + }, + "NodeGroups": { + "shape_name": "NodeGroupList", + "type": "list", + "members": { + "shape_name": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PrimaryEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "NodeGroupMembers": { + "shape_name": "NodeGroupMemberList", + "type": "list", + "members": { + "shape_name": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " + }, + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " + }, + "ReadEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " + }, + "CurrentRole": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " + } + }, + "documentation": "\nRepresents a single node within a node group.
\n ", + "xmlname": "NodeGroupMember" + }, + "documentation": "\nA list containing information about individual nodes within the node group.
\n " + } + }, + "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", + "xmlname": "NodeGroup" + }, + "documentation": "\nA single element list with information about the nodes in the replication group.
\n " + }, + "SnapshottingClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains all of the attributes of a specific replication group.
\n ", + "xmlname": "ReplicationGroup" + }, + "documentation": "\nA list of replication groups. Each item in the list contains detailed information about\n one replication group.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeReplicationGroups operation.
\n " + }, + "errors": [ + { + "shape_name": "ReplicationGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified replication group does not exist.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeReplicationGroups operation returns information about a particular\n replication group. If no identifier is specified, DescribeReplicationGroups\n returns information about all replication groups.
\nThe reserved cache node identifier filter value. Use this parameter to show only the\n reservation that matches the specified reservation ID.
\n " + }, + "ReservedCacheNodesOfferingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering identifier filter value. Use this parameter to show only purchased\n reservations matching the specified offering identifier.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type filter value. Use this parameter to show only those reservations\n matching the specified cache node type.
\n " + }, + "Duration": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe duration filter value, specified in years or seconds. Use this parameter to show only\n reservations for this duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only those reservations\n matching the specified product description.
\n " + }, + "OfferingType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.
\nValid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeReservedCacheNodes operation.
\n " + }, + "output": { + "shape_name": "ReservedCacheNodeMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "ReservedCacheNodes": { + "shape_name": "ReservedCacheNodeList", + "type": "list", + "members": { + "shape_name": "ReservedCacheNode", + "type": "structure", + "members": { + "ReservedCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe unique identifier for the reservation.
\n " + }, + "ReservedCacheNodesOfferingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering identifier.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type for the reserved cache nodes.
\n " + }, + "StartTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe time the reservation started.
\n " + }, + "Duration": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe duration of the reservation in seconds.
\n " + }, + "FixedPrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price charged for this reserved cache node.
\n " + }, + "UsagePrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe hourly price charged for this reserved cache node.
\n " + }, + "CacheNodeCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of cache nodes that have been reserved.
\n " + }, + "ProductDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the reserved cache node.
\n " + }, + "OfferingType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering type of this reserved cache node.
\n " + }, + "State": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe state of the reserved cache node.
\n " + }, + "RecurringCharges": { + "shape_name": "RecurringChargeList", + "type": "list", + "members": { + "shape_name": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe monetary amount of the recurring charge.
\n " + }, + "RecurringChargeFrequency": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe frequency of the recurring charge.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", + "xmlname": "RecurringCharge" + }, + "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of a PurchaseReservedCacheNodesOffering operation.
\n ", + "xmlname": "ReservedCacheNode" + }, + "documentation": "\nA list of reserved cache nodes. Each element in the list contains detailed information\n about one node.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeReservedCacheNodes operation.
\n " + }, + "errors": [ + { + "shape_name": "ReservedCacheNodeNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested reserved cache node was not found.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeReservedCacheNodes operation returns information about reserved cache\n nodes for this account, or about a specified reserved cache node.
\nThe offering identifier filter value. Use this parameter to show only the available\n offering that matches the specified reservation identifier.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
The cache node type filter value. Use this parameter to show only the available offerings\n matching the specified cache node type.
\n " + }, + "Duration": { + "shape_name": "String", + "type": "string", + "documentation": "\nDuration filter value, specified in years or seconds. Use this parameter to show only\n reservations for a given duration.
\nValid Values: 1 | 3 | 31536000 | 94608000
The product description filter value. Use this parameter to show only the available\n offerings matching the specified product description.
\n " + }, + "OfferingType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering type filter value. Use this parameter to show only the available offerings\n matching the specified offering type.
\nValid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"\n
The maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 100
\nConstraints: minimum 20; maximum 100.
\n " + }, + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeReservedCacheNodesOfferings operation.
\n " + }, + "output": { + "shape_name": "ReservedCacheNodesOfferingMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": " \nProvides an identifier to allow retrieval of paginated results.
\n " + }, + "ReservedCacheNodesOfferings": { + "shape_name": "ReservedCacheNodesOfferingList", + "type": "list", + "members": { + "shape_name": "ReservedCacheNodesOffering", + "type": "structure", + "members": { + "ReservedCacheNodesOfferingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nA unique identifier for the reserved cache node offering.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type for the reserved cache node.
\n " + }, + "Duration": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe duration of the offering. in seconds.
\n " + }, + "FixedPrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price charged for this offering.
\n " + }, + "UsagePrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe hourly price charged for this offering.
\n " + }, + "ProductDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache engine used by the offering.
\n " + }, + "OfferingType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering type.
\n " + }, + "RecurringCharges": { + "shape_name": "RecurringChargeList", + "type": "list", + "members": { + "shape_name": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe monetary amount of the recurring charge.
\n " + }, + "RecurringChargeFrequency": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe frequency of the recurring charge.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", + "xmlname": "RecurringCharge" + }, + "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " + } + }, + "wrapper": true, + "documentation": "\nDescribes all of the attributes of a reserved cache node offering.
\n ", + "xmlname": "ReservedCacheNodesOffering" + }, + "documentation": "\nA list of reserved cache node offerings. Each element in the list contains detailed\n information about one offering.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeReservedCacheNodesOfferings operation.
\n " + }, + "errors": [ + { + "shape_name": "ReservedCacheNodesOfferingNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache node offering does not exist.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeReservedCacheNodesOfferings operation lists available reserved cache\n node offerings.
\nA user-supplied cluster identifier. If this parameter is specified, only snapshots\n associated with that specific cache cluster will be described.
\n " + }, + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nA user-supplied name of the snapshot. If this parameter is specified, only this snapshot\n will be described.
\n " + }, + "SnapshotSource": { + "shape_name": "String", + "type": "string", + "documentation": "\nIf set to system, the output shows snapshots that were automatically created by ElastiCache. \n If set to user the output shows snapshots that were manually created. \n If omitted, the output shows both automatically and manually created snapshots.
An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n " + }, + "MaxRecords": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": " \n \nThe maximum number of records to include in the response. If more records exist than the\n specified MaxRecords value, a marker is included in the response so that\n the remaining results can be retrieved.
Default: 50
\nConstraints: minimum 20; maximum 50.
\n " + } + }, + "documentation": "\nRepresents the input of a DescribeSnapshotsMessage operation.
\n " + }, + "output": { + "shape_name": "DescribeSnapshotsListMessage", + "type": "structure", + "members": { + "Marker": { + "shape_name": "String", + "type": "string", + "documentation": "\n \nAn optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this\n parameter is specified, the response includes only records beyond the marker, up to the\n value specified by MaxRecords.
\n \n " + }, + "Snapshots": { + "shape_name": "SnapshotList", + "type": "list", + "members": { + "shape_name": "Snapshot", + "type": "structure", + "members": { + "SnapshotName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.
\n " + }, + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the source cache cluster.
\n " + }, + "SnapshotStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the snapshot. Valid values: creating | available\n | restoring | copying | deleting.
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
The name of the compute and memory capacity node type for the source cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) used by the source cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used by the source cache cluster.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the source cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the source cache cluster is located.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur on the source\n cache cluster.
\n " + }, + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) for the topic used by the source cache cluster for\n publishing notifications.
\n " + }, + "Port": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe port number used by each cache nodes in the source cache cluster.
\n " + }, + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache parameter group that is associated with the source cache cluster.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the source cache cluster.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the\n source cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nFor the source cache cluster, indicates whether minor version patches are applied\n automatically (true) or not (false).
For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.
\nFor manual snapshots, this field reflects the SnapshotRetentionLimit for the\n source cache cluster when the snapshot was created. This field is otherwise ignored:\n Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot\n action.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range during which ElastiCache takes daily snapshots of the source cache\n cluster.
\n " + }, + "NodeSnapshots": { + "shape_name": "NodeSnapshotList", + "type": "list", + "members": { + "shape_name": "NodeSnapshot", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier for the node in the source cache cluster.
\n " + }, + "CacheSize": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe size of the cache on the source cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created in the source cache cluster.
\n " + }, + "SnapshotCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the source node's metadata and cache data set was obtained for the snapshot.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents an individual cache node in a snapshot of a cache cluster.
\n ", + "xmlname": "NodeSnapshot" + }, + "documentation": "\nA list of the cache nodes in the source cache cluster.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents a copy of an entire cache cluster as of the time when the snapshot was taken.
\n ", + "xmlname": "Snapshot" + }, + "documentation": "\nA list of snapshots. Each item in the list contains detailed information about one\n snapshot.
\n " + } + }, + "documentation": "\nRepresents the output of a DescribeSnapshots operation.
\n " + }, + "errors": [ + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "SnapshotNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested snapshot name does not refer to an existing snapshot.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe DescribeSnapshots operation returns information about cache cluster snapshots.\n By default, DescribeSnapshots lists all of your snapshots; it can optionally\n describe a single snapshot, or just the snapshots associated with a particular cache\n cluster.
\nThe cache cluster identifier. This value is stored as a lowercase string.
\n ", + "required": true + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes that the cache cluster should have. \n If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and \n the number of cache nodes pending creation (which may be zero), then more nodes will be added. \n If the value is less than the number of existing cache nodes, then nodes will be removed. \n If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.
If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.
For cache clusters running Redis, the value of NumCacheNodesmust be 1.
Note:
Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
\n A pending action to modify the number of cache nodes in a cluster during its maintenance window, \n whether by adding or removing nodes in accordance with the scale out architecture, is not queued. \n The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the \n number of cache nodes in the cluster. \n For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. \n Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. \n As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, \n a request to add nodes does not automatically override a previous pending action to add nodes. \n The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. \n To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and \n set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.
A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002,\n etc.). This parameter is only valid when NumCacheNodes is less than the existing number\n of cache nodes. The number of cache node IDs supplied in this parameter must match the\n difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is\n greater, and the value of NumCacheNodes in the request.
\nFor example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this \n ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.
A list of cache security group names to authorize on this cache cluster. This change is\n asynchronously applied as soon as possible.
\nThis parameter can be used only with clusters that are created outside of an Amazon\n Virtual Private Cloud (VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
\n " + }, + "SecurityGroupIds": { + "shape_name": "SecurityGroupIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\nSpecifies the VPC Security Groups associated with the cache cluster.
\nThis parameter can be used only with clusters that are created in an Amazon Virtual\n Private Cloud (VPC).
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe weekly time range (in UTC) during which system maintenance can occur. Note that\n system maintenance may result in an outage. This change is made immediately. If you are\n moving this window to the current time, there must be at least 120 minutes between the\n current time and end of the window to ensure that pending changes are applied.
\n " + }, + "NotificationTopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
\nThe name of the cache parameter group to apply to this cache cluster. This change is\n asynchronously applied as soon as possible for parameters when the\n ApplyImmediately parameter is specified as true for this request.
\n " + }, + "NotificationTopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon SNS notification topic. Notifications are sent only if the\n status is active.
\nValid values: active | inactive
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the cache cluster.
If false, then changes to the cache cluster are applied on the next\n maintenance reboot, or the next failure reboot, whichever occurs first.
ModifyCacheCluster before a pending modification is applied, the pending modification\n is replaced by the newer modification.Valid values: true | false
Default: false
The upgraded version of the cache engine to be run on the cache nodes.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "BooleanOptional", + "type": "boolean", + "documentation": "\nIf true, then minor engine upgrades will be applied automatically to the\n cache cluster during the maintenance window.
Valid values: true | false
Default: true
The number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\n " + }, + "AZMode": { + "shape_name": "String", + "type": "string", + "documentation": "\nSpecifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or \n created across multiple Availability Zones.
\nValid values: single-az | cross-az.
This option is only supported for Memcached cache clusters.
\nYou cannot specify single-az if the Memcached cache cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.
Only newly created nodes will be located in different Availability Zones. For instructions on how to move existing Memcached\n nodes to different Availability Zones, see the Availability Zone Considerations\n section of Cache Node Considerations for Memcached.
\nThe list of Availability Zones where the new Memcached cache nodes will be created.
\nThis parameter is only valid when NumCacheNodes in the request is greater \n than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). \n The number of Availability Zones supplied in this list must match the cache nodes being added in this request.
\n This option is only supported on Memcached clusters. \n
\nScenarios:\n
NumCacheNodes=5 (3 + 2) and opitonally specify two Availability Zones for the two new nodes.NumCacheNodes=6 ((3 + 2) + 1)NumCacheNodes=3 (the original number of nodes).\n \n The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, \n add 0 nodes by setting NumCacheNodes to the number of current nodes.
\n If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. \n Only newly created nodes can be located in different Availability Zones. \n For guidance on how to move existing Memcached nodes to different Availability Zones, see the\n Availability Zone Considerations section of \n Cache Node Considerations for Memcached.\n
Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d
Represents the input of a ModifyCacheCluster operation.
\n " + }, + "output": { + "shape_name": "CacheClusterWrapper", + "type": "structure", + "members": { + "CacheCluster": { + "shape_name": "CacheCluster", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " + }, + "ConfigurationEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "ClientDownloadLandingPage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " + }, + "CacheClusterStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " + }, + "PendingModifiedValues": { + "shape_name": "PendingModifiedValues", + "type": "structure", + "members": { + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " + }, + "CacheNodeIdsToRemove": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " + } + }, + "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " + }, + "NotificationConfiguration": { + "shape_name": "NotificationConfiguration", + "type": "structure", + "members": { + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " + }, + "TopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of the topic.
\n " + } + }, + "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroupMembershipList", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroupMembership", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", + "xmlname": "CacheSecurityGroup" + }, + "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " + }, + "CacheParameterGroup": { + "shape_name": "CacheParameterGroupStatus", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "ParameterApplyStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of parameter updates.
\n " + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + } + }, + "documentation": "\nThe status of the cache parameter group.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " + }, + "CacheNodes": { + "shape_name": "CacheNodeList", + "type": "list", + "members": { + "shape_name": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " + }, + "CacheNodeStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created.
\n " + }, + "Endpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " + }, + "ParameterGroupStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the parameter group applied to this cache node.
\n " + }, + "SourceCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " + }, + "CustomerAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where this node was created and now resides.
\n " + } + }, + "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", + "xmlname": "CacheNode" + }, + "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a single cache security group and its status..
\n " + }, + "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " + }, + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " + } + } + }, + "errors": [ + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "InvalidCacheSecurityGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " + }, + { + "shape_name": "InsufficientCacheClusterCapacityFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache node type is not available in the specified Availability Zone.
\n " + }, + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "NodeQuotaForClusterExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n in a single cache cluster.
\n " + }, + { + "shape_name": "NodeQuotaForCustomerExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of cache nodes\n per customer.
\n " + }, + { + "shape_name": "CacheSecurityGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidVPCNetworkStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe VPC network is in an invalid state.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe ModifyCacheCluster operation modifies the settings for a cache cluster. You\n can use this operation to change one or more cluster configuration parameters by\n specifying the parameters and the new values.
\nThe name of the cache parameter group to modify.
\n ", + "required": true + }, + "ParameterNameValues": { + "shape_name": "ParameterNameValueList", + "type": "list", + "members": { + "shape_name": "ParameterNameValue", + "type": "structure", + "members": { + "ParameterName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the parameter.
\n " + }, + "ParameterValue": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value of the parameter.
\n " + } + }, + "documentation": "\nDescribes a name-value pair that is used to update the value of a parameter.
\n ", + "xmlname": "ParameterNameValue" + }, + "documentation": "\nAn array of parameter names and values for the parameter update. You must supply at least\n one parameter name and value; subsequent arguments are optional. A maximum of 20\n parameters may be modified per request.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a ModifyCacheParameterGroup operation.
\n " + }, + "output": { + "shape_name": "CacheParameterGroupNameMessage", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + } + }, + "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidCacheParameterGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe ModifyCacheParameterGroup operation modifies the parameters of a cache\n parameter group. You can modify up to 20 parameters in a single request by submitting a\n list parameter name and value pairs.
\nThe name for the cache subnet group. This value is stored as a lowercase string.
\nConstraints: Must contain no more than 255 alphanumeric characters or hyphens.
\nExample: mysubnetgroup
A description for the cache subnet group.
\n " + }, + "SubnetIds": { + "shape_name": "SubnetIdentifierList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SubnetIdentifier" + }, + "documentation": "\nThe EC2 subnet IDs for the cache subnet group.
\n " + } + }, + "documentation": "\nRepresents the input of a ModifyCacheSubnetGroup operation.
\n " + }, + "output": { + "shape_name": "CacheSubnetGroupWrapper", + "type": "structure", + "members": { + "CacheSubnetGroup": { + "shape_name": "CacheSubnetGroup", + "type": "structure", + "members": { + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group.
\n " + }, + "CacheSubnetGroupDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache subnet group.
\n " + }, + "VpcId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.
\n " + }, + "Subnets": { + "shape_name": "SubnetList", + "type": "list", + "members": { + "shape_name": "Subnet", + "type": "structure", + "members": { + "SubnetIdentifier": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe unique identifier for the subnet
\n " + }, + "SubnetAvailabilityZone": { + "shape_name": "AvailabilityZone", + "type": "structure", + "members": { + "Name": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone.
\n " + } + }, + "wrapper": true, + "documentation": "\nThe Availability Zone associated with the subnet
\n " + } + }, + "documentation": "\nRepresents the subnet associated with a cache cluster. This parameter refers to subnets\n defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.
\n ", + "xmlname": "Subnet" + }, + "documentation": "\nA list of subnets associated with the cache subnet group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache subnet group name does not refer to an existing cache subnet\n group.
\n " + }, + { + "shape_name": "CacheSubnetQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the allowed number of subnets in\n a cache subnet group.
\n " + }, + { + "shape_name": "SubnetInUse", + "type": "structure", + "members": {}, + "documentation": "\nThe requested subnet is being used by another cache subnet group.
\n " + }, + { + "shape_name": "InvalidSubnet", + "type": "structure", + "members": {}, + "documentation": "\nAn invalid subnet identifier was specified.
\n " + } + ], + "documentation": "\nThe ModifyCacheSubnetGroup operation modifies an existing cache subnet group.
\nThe identifier of the replication group to modify.
\n ", + "required": true + }, + "ReplicationGroupDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nA description for the replication group. Maximum length is 255 characters.
\n " + }, + "CacheSecurityGroupNames": { + "shape_name": "CacheSecurityGroupNameList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheSecurityGroupName" + }, + "documentation": "\nA list of cache security group names to authorize for the clusters in this replication\n group. This change is asynchronously applied as soon as possible.
\nThis parameter can be used only with replication groups containing cache clusters running\n outside of an Amazon Virtual Private Cloud (VPC).
\nConstraints: Must contain no more than 255 alphanumeric characters. Must not be\n \"Default\".
\n " + }, + "SecurityGroupIds": { + "shape_name": "SecurityGroupIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "SecurityGroupId" + }, + "documentation": "\nSpecifies the VPC Security Groups associated with the cache clusters in the replication\n group.
\nThis parameter can be used only with replication groups containing cache clusters running\n in an Amazon Virtual Private Cloud (VPC).
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe weekly time range (in UTC) during which replication group system maintenance can\n occur. Note that system maintenance may result in an outage. This change is made\n immediately. If you are moving this window to the current time, there must be at least\n 120 minutes between the current time and end of the window to ensure that pending\n changes are applied.
\n " + }, + "NotificationTopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
\nThe name of the cache parameter group to apply to all of the cache nodes in this\n replication group. This change is asynchronously applied as soon as possible for\n parameters when the ApplyImmediately parameter is specified as true for\n this request.
\n " + }, + "NotificationTopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon SNS notification topic for the replication group. Notifications\n are sent only if the status is active.
\nValid values: active | inactive
If true, this parameter causes the modifications in this request and any\n pending modifications to be applied, asynchronously and as soon as possible, regardless\n of the PreferredMaintenanceWindow setting for the replication group.
If false, then changes to the nodes in the replication group are applied on\n the next maintenance reboot, or the next failure reboot, whichever occurs first.
Valid values: true | false
Default: false
The upgraded version of the cache engine to be run on the nodes in the replication\n group..
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "BooleanOptional", + "type": "boolean", + "documentation": "\nDetermines whether minor engine upgrades will be applied automatically to all of the\n cache nodes in the replication group during the maintenance window. A value of\n true allows these upgrades to occur; false disables\n automatic upgrades.
If this parameter is specified, ElastiCache will promote each of the nodes in the specified\n cache cluster to the primary role. The nodes of all other clusters in the replication\n group will be read replicas.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n the cache cluster specified by SnapshottingClusterId.
\nExample: 05:00-09:00
If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.
\n \n " + }, + "SnapshottingClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster ID that will be used as the daily snapshot source for the replication\n group.
\n " + } + }, + "documentation": "\nRepresents the input of a ModifyReplicationGroups operation.
\n " + }, + "output": { + "shape_name": "ReplicationGroupWrapper", + "type": "structure", + "members": { + "ReplicationGroup": { + "shape_name": "ReplicationGroup", + "type": "structure", + "members": { + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the replication group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the replication group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PendingModifiedValues": { + "shape_name": "ReplicationGroupPendingModifiedValues", + "type": "structure", + "members": { + "PrimaryClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe primary cluster ID which will be applied immediately (if\n --apply-immediately was specified), or during the next maintenance\n window.
A group of settings to be applied to the replication group, either immediately or during\n the next maintenance window.
\n " + }, + "MemberClusters": { + "shape_name": "ClusterIdList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "ClusterId" + }, + "documentation": "\nThe names of all the cache clusters that are part of this replication group.
\n " + }, + "NodeGroups": { + "shape_name": "NodeGroupList", + "type": "list", + "members": { + "shape_name": "NodeGroup", + "type": "structure", + "members": { + "NodeGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe identifier for the node group. A replication group contains only one node group;\n therefore, the node group ID is 0001.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this replication group - creating, available, etc.
\n " + }, + "PrimaryEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "NodeGroupMembers": { + "shape_name": "NodeGroupMemberList", + "type": "list", + "members": { + "shape_name": "NodeGroupMember", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the cache cluster to which the node belongs.
\n " + }, + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the node within its cache cluster. A node ID is a numeric identifier (0001,\n 0002, etc.).
\n " + }, + "ReadEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the node is located.
\n " + }, + "CurrentRole": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe role that is currently assigned to the node - primary or replica.
\n " + } + }, + "documentation": "\nRepresents a single node within a node group.
\n ", + "xmlname": "NodeGroupMember" + }, + "documentation": "\nA list containing information about individual nodes within the node group.
\n " + } + }, + "documentation": "\nRepresents a collection of cache nodes in a replication group.
\n ", + "xmlname": "NodeGroup" + }, + "documentation": "\nA single element list with information about the nodes in the replication group.
\n " + }, + "SnapshottingClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache cluster ID that is used as the daily snapshot source for the replication\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains all of the attributes of a specific replication group.
\n " + } + } + }, + "errors": [ + { + "shape_name": "ReplicationGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified replication group does not exist.
\n " + }, + { + "shape_name": "InvalidReplicationGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested replication group is not in the available state.
\n " + }, + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "InvalidCacheSecurityGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " + }, + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + }, + { + "shape_name": "CacheSecurityGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidVPCNetworkStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe VPC network is in an invalid state.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe ModifyReplicationGroup operation modifies the settings for a replication\n group.
\nThe ID of the reserved cache node offering to purchase.
\nExample: 438012d3-4052-4cc7-b2e3-8d3372e0e706
\n ", + "required": true + }, + "ReservedCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nA customer-specified identifier to track this reservation.
\nExample: myreservationID
\n " + }, + "CacheNodeCount": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache node instances to reserve.
\nDefault: 1
Represents the input of a PurchaseReservedCacheNodesOffering operation.
\n " + }, + "output": { + "shape_name": "ReservedCacheNodeWrapper", + "type": "structure", + "members": { + "ReservedCacheNode": { + "shape_name": "ReservedCacheNode", + "type": "structure", + "members": { + "ReservedCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe unique identifier for the reservation.
\n " + }, + "ReservedCacheNodesOfferingId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering identifier.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node type for the reserved cache nodes.
\n " + }, + "StartTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe time the reservation started.
\n " + }, + "Duration": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe duration of the reservation in seconds.
\n " + }, + "FixedPrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe fixed price charged for this reserved cache node.
\n " + }, + "UsagePrice": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe hourly price charged for this reserved cache node.
\n " + }, + "CacheNodeCount": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe number of cache nodes that have been reserved.
\n " + }, + "ProductDescription": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the reserved cache node.
\n " + }, + "OfferingType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe offering type of this reserved cache node.
\n " + }, + "State": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe state of the reserved cache node.
\n " + }, + "RecurringCharges": { + "shape_name": "RecurringChargeList", + "type": "list", + "members": { + "shape_name": "RecurringCharge", + "type": "structure", + "members": { + "RecurringChargeAmount": { + "shape_name": "Double", + "type": "double", + "documentation": "\nThe monetary amount of the recurring charge.
\n " + }, + "RecurringChargeFrequency": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe frequency of the recurring charge.
\n " + } + }, + "wrapper": true, + "documentation": "\nContains the specific price and frequency of a recurring charges for a reserved cache\n node, or for a reserved cache node offering.
\n ", + "xmlname": "RecurringCharge" + }, + "documentation": "\nThe recurring price charged to run this reserved cache node.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of a PurchaseReservedCacheNodesOffering operation.
\n " + } + } + }, + "errors": [ + { + "shape_name": "ReservedCacheNodesOfferingNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache node offering does not exist.
\n " + }, + { + "shape_name": "ReservedCacheNodeAlreadyExistsFault", + "type": "structure", + "members": {}, + "documentation": "\nYou already have a reservation with the given identifier.
\n " + }, + { + "shape_name": "ReservedCacheNodeQuotaExceededFault", + "type": "structure", + "members": {}, + "documentation": "\nThe request cannot be processed because it would exceed the user's cache node quota.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved\n cache node offering.
\nThe cache cluster identifier. This parameter is stored as a lowercase string.
\n ", + "required": true + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs to reboot. A node ID is a numeric identifier (0001,\n 0002, etc.). To reboot an entire cache cluster, specify all of the cache node\n IDs.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a RebootCacheCluster operation.
\n " + }, + "output": { + "shape_name": "CacheClusterWrapper", + "type": "structure", + "members": { + "CacheCluster": { + "shape_name": "CacheCluster", + "type": "structure", + "members": { + "CacheClusterId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe user-supplied identifier of the cache cluster. This is a unique key that identifies a\n cache cluster.
\n " + }, + "ConfigurationEndpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nRepresents the information required for client programs to connect to a cache node.
\n " + }, + "ClientDownloadLandingPage": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe URL of the web page where you can download the latest ElastiCache client library.
\n " + }, + "CacheNodeType": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the compute and memory capacity node type for the cache cluster.
\n " + }, + "Engine": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache engine (memcached or redis) to be used for this cache\n cluster.
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe version of the cache engine version that is used in this cache cluster.
\n " + }, + "CacheClusterStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache cluster - creating, available, etc.
\n " + }, + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of cache nodes in the cache cluster.
\n " + }, + "PreferredAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Availability Zone in which the cache cluster is located or \n \"Multiple\" if the cache nodes are located in different Availability Zones.
\n " + }, + "CacheClusterCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache cluster was created.
\n " + }, + "PreferredMaintenanceWindow": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe time range (in UTC) during which weekly system maintenance can occur.
\n " + }, + "PendingModifiedValues": { + "shape_name": "PendingModifiedValues", + "type": "structure", + "members": { + "NumCacheNodes": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe new number of cache nodes for the cache cluster.
\n " + }, + "CacheNodeIdsToRemove": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of cache node IDs that are being removed (or will be removed) from the cache\n cluster. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + }, + "EngineVersion": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe new cache engine version that the cache cluster will run.
\n " + } + }, + "documentation": "\nA group of settings that will be applied to the cache cluster in the future, or that are\n currently being applied.
\n " + }, + "NotificationConfiguration": { + "shape_name": "NotificationConfiguration", + "type": "structure", + "members": { + "TopicArn": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Amazon Resource Name (ARN) that identifies the topic.
\n " + }, + "TopicStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of the topic.
\n " + } + }, + "documentation": "\nDescribes a notification topic and its status. Notification topics are used for\n publishing ElastiCache events to subscribers using Amazon Simple Notification Service\n (SNS).
\n " + }, + "CacheSecurityGroups": { + "shape_name": "CacheSecurityGroupMembershipList", + "type": "list", + "members": { + "shape_name": "CacheSecurityGroupMembership", + "type": "structure", + "members": { + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe membership status in the cache security group. The status changes when a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a cache cluster's status within a particular cache security group.
\n ", + "xmlname": "CacheSecurityGroup" + }, + "documentation": "\nA list of cache security group elements, composed of name and status sub-elements.
\n " + }, + "CacheParameterGroup": { + "shape_name": "CacheParameterGroupStatus", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + }, + "ParameterApplyStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of parameter updates.
\n " + }, + "CacheNodeIdsToReboot": { + "shape_name": "CacheNodeIdsList", + "type": "list", + "members": { + "shape_name": "String", + "type": "string", + "documentation": null, + "xmlname": "CacheNodeId" + }, + "documentation": "\nA list of the cache node IDs which need to be rebooted for parameter changes to be\n applied. A node ID is a numeric identifier (0001, 0002, etc.).
\n " + } + }, + "documentation": "\nThe status of the cache parameter group.
\n " + }, + "CacheSubnetGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache subnet group associated with the cache cluster.
\n " + }, + "CacheNodes": { + "shape_name": "CacheNodeList", + "type": "list", + "members": { + "shape_name": "CacheNode", + "type": "structure", + "members": { + "CacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The\n combination of cluster ID and node ID uniquely identifies every cache node used in a\n customer's AWS account.
\n " + }, + "CacheNodeStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe current state of this cache node.
\n " + }, + "CacheNodeCreateTime": { + "shape_name": "TStamp", + "type": "timestamp", + "documentation": "\nThe date and time when the cache node was created.
\n " + }, + "Endpoint": { + "shape_name": "Endpoint", + "type": "structure", + "members": { + "Address": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe DNS hostname of the cache node.
\n " + }, + "Port": { + "shape_name": "Integer", + "type": "integer", + "documentation": "\nThe port number that the cache engine is listening on.
\n " + } + }, + "documentation": "\nThe hostname and IP address for connecting to this cache node.
\n " + }, + "ParameterGroupStatus": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the parameter group applied to this cache node.
\n " + }, + "SourceCacheNodeId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe ID of the primary node to which this read replica node is synchronized. If this field\n is empty, then this node is not associated with a primary cache cluster.
\n " + }, + "CustomerAvailabilityZone": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe Availability Zone where this node was created and now resides.
\n " + } + }, + "documentation": "\nRepresents an individual cache node within a cache cluster. Each cache node runs its own\n instance of the cluster's protocol-compliant caching software - either Memcached or\n Redis.
\n ", + "xmlname": "CacheNode" + }, + "documentation": "\nA list of cache nodes that are members of the cache cluster.
\n " + }, + "AutoMinorVersionUpgrade": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, then minor version patches are applied automatically; if\n false, then automatic minor version patches are disabled.
The identifier of the cache security group.
\n " + }, + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the cache security group membership. The status changes whenever a cache\n security group is modified, or when the cache security groups assigned to a cache\n cluster are modified.
\n " + } + }, + "documentation": "\nRepresents a single cache security group and its status..
\n " + }, + "documentation": "\nA list of VPC Security Groups associated with the cache cluster.
\n " + }, + "ReplicationGroupId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe replication group to which this cache cluster belongs. If this field is empty, the\n cache cluster is not associated with any replication group.
\n " + }, + "SnapshotRetentionLimit": { + "shape_name": "IntegerOptional", + "type": "integer", + "documentation": "\nThe number of days for which ElastiCache will retain automatic cache cluster snapshots before\n deleting them. For example, if you set SnapshotRetentionLimit to 5, then a\n snapshot that was taken today will be retained for 5 days before being deleted.
\nImportant
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.
The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of\n your cache cluster.
\nExample: 05:00-09:00
Contains all of the attributes of a specific cache cluster.
\n " + } + } + }, + "errors": [ + { + "shape_name": "InvalidCacheClusterStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster is not in the available state.
\n " + }, + { + "shape_name": "CacheClusterNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache cluster ID does not refer to an existing cache cluster.
\n " + } + ], + "documentation": "\nThe RebootCacheCluster operation reboots some, or all, of the cache nodes\n within a provisioned cache cluster. This API will apply any modified cache parameter\n groups to the cache cluster. The reboot action takes place as soon as possible, and\n results in a momentary outage to the cache cluster. During the reboot, the cache cluster\n status is set to REBOOTING.
\nThe reboot causes the contents of the cache (for each cache node being rebooted)\n to be lost.
\nWhen the reboot is complete, a cache cluster event is created.
\nThe name of the cache parameter group to reset.
\n ", + "required": true + }, + "ResetAllParameters": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIf true, all parameters in the cache parameter group will be reset to default\n values. If false, no such action occurs.
\nValid values: true | false
The name of the parameter.
\n " + }, + "ParameterValue": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe value of the parameter.
\n " + } + }, + "documentation": "\nDescribes a name-value pair that is used to update the value of a parameter.
\n ", + "xmlname": "ParameterNameValue" + }, + "documentation": "\nAn array of parameter names to be reset. If you are not resetting the entire cache\n parameter group, you must specify at least one parameter name.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a ResetCacheParameterGroup operation.
\n " + }, + "output": { + "shape_name": "CacheParameterGroupNameMessage", + "type": "structure", + "members": { + "CacheParameterGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache parameter group.
\n " + } + }, + "documentation": "\nRepresents the output of one of the following operations:
\nThe current state of the cache parameter group does not allow the requested action to\n occur.
\n " + }, + { + "shape_name": "CacheParameterGroupNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe requested cache parameter group name does not refer to an existing cache parameter\n group.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe ResetCacheParameterGroup operation modifies the parameters of a cache\n parameter group to the engine or system default value. You can reset specific parameters\n by submitting a list of parameter names. To reset the entire cache parameter group,\n specify the ResetAllParameters and CacheParameterGroupName parameters.
\nThe name of the cache security group to revoke ingress from.
\n ", + "required": true + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Amazon EC2 security group to revoke access from.
\n ", + "required": true + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account number of the Amazon EC2 security group owner. Note that this is not the\n same thing as an AWS access key ID - you must provide a valid AWS account number for\n this parameter.
\n ", + "required": true + } + }, + "documentation": "\nRepresents the input of a RevokeCacheSecurityGroupIngress operation.
\n " + }, + "output": { + "shape_name": "CacheSecurityGroupWrapper", + "type": "structure", + "members": { + "CacheSecurityGroup": { + "shape_name": "CacheSecurityGroup", + "type": "structure", + "members": { + "OwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the cache security group owner.
\n " + }, + "CacheSecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the cache security group.
\n " + }, + "Description": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe description of the cache security group.
\n " + }, + "EC2SecurityGroups": { + "shape_name": "EC2SecurityGroupList", + "type": "list", + "members": { + "shape_name": "EC2SecurityGroup", + "type": "structure", + "members": { + "Status": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe status of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupName": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe name of the Amazon EC2 security group.
\n " + }, + "EC2SecurityGroupOwnerId": { + "shape_name": "String", + "type": "string", + "documentation": "\nThe AWS account ID of the Amazon EC2 security group owner.
\n " + } + }, + "documentation": "\nProvides ownership and status information for an Amazon EC2 security group.
\n ", + "xmlname": "EC2SecurityGroup" + }, + "documentation": "\nA list of Amazon EC2 security groups that are associated with this cache security\n group.
\n " + } + }, + "wrapper": true, + "documentation": "\nRepresents the output of one of the following operations:
\nThe requested cache security group name does not refer to an existing cache security\n group.
\n " + }, + { + "shape_name": "AuthorizationNotFoundFault", + "type": "structure", + "members": {}, + "documentation": "\nThe specified Amazon EC2 security group is not authorized for the specified cache\n security group.
\n " + }, + { + "shape_name": "InvalidCacheSecurityGroupStateFault", + "type": "structure", + "members": {}, + "documentation": "\nThe current state of the cache security group does not allow deletion.
\n " + }, + { + "shape_name": "InvalidParameterValueException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nA parameter value is invalid.
\n " + } + }, + "documentation": "\nThe value for a parameter is invalid.
\n " + }, + { + "shape_name": "InvalidParameterCombinationException", + "type": "structure", + "members": { + "message": { + "shape_name": "AwsQueryErrorMessage", + "type": "string", + "documentation": "\nTwo or more parameters that must not be used together were used together.
\n " + } + }, + "documentation": "\nTwo or more incompatible parameters were specified.
\n " + } + ], + "documentation": "\nThe RevokeCacheSecurityGroupIngress operation revokes ingress from a cache\n security group. Use this operation to disallow access from an Amazon EC2 security group\n that had been previously authorized.
\n\n Elastic Load Balancing is a cost-effective and easy\n to use web service to help you improve the availability and\n scalability of your application running on Amazon Elastic Cloud Compute (Amazon EC2). It makes it easy for\n you to distribute application loads between two or more\n EC2 instances. Elastic Load Balancing supports the growth in traffic of your application by enabling availability through redundancy.\n
\n \nThis guide provides detailed information about Elastic Load Balancing \n actions, data types, and parameters that can be used for sending a \n query request. Query requests are HTTP or HTTPS requests that use the \n HTTP verb GET or POST and a query parameter named Action or Operation. \n Action is used throughout this documentation, although Operation is \n supported for backward compatibility with other AWS Query APIs.
\n \nFor detailed information on constructing a query request using the actions, data types, and parameters mentioned in this guide,\n go to Using the Query API\n in the Elastic Load Balancing Developer Guide.
\n \nFor detailed information about Elastic Load Balancing features and their associated actions, go to \n Using Elastic Load Balancing\n in the Elastic Load Balancing Developer Guide.
\n \nThis reference guide is based on the current WSDL, which is available at:\n \n
\nEndpoints
\nThe examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
\nYou can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see \n Regions and Endpoints \n in the Amazon Web Services General Reference.\n
\n \n ", + "documentation": "\n \tElastic Load Balancing is a way to automatically distribute incoming web traffic across \n applications that run on multiple Amazon Elastic Compute Cloud (Amazon EC2) instances. \n
\n \nYou can create, access, and manage Elastic Load Balancing \n using the AWS Management Console or the Elastic Load Balancing API. \n For more information about Elastic Load Balancing interfaces, see Accessing Elastic Load Balancing.
\n \nThis reference guide contains documentation for the Query API and the AWS command line interface commands, to manage Elastic Load Balancing.
\n \nFor detailed information about Elastic Load Balancing features and their associated actions or commands, go to \n Managing Load Balancers\n in the Elastic Load Balancing Developer Guide.
\n \nThis reference guide is based on the current WSDL, which is available at:\n .
\nEndpoints
\nThe examples in this guide assume that your load balancers are created in the US East (Northern Virginia) region and use us-east-1 as the endpoint.
\nYou can create your load balancers in other AWS regions. For information about regions and endpoints supported by Elastic Load Balancing, see \n Regions and Endpoints \n in the Amazon Web Services General Reference.\n
\n \n ", "operations": { + "AddTags": { + "name": "AddTags", + "input": { + "shape_name": "AddTagsInput", + "type": "structure", + "members": { + "LoadBalancerNames": { + "shape_name": "LoadBalancerNames", + "type": "list", + "members": { + "shape_name": "AccessPointName", + "type": "string", + "documentation": null + }, + "documentation": "\nThe name of the load balancer to tag. You can specify a maximum of one load balancer name.
\n ", + "required": true + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 1, + "max_length": 128, + "documentation": "\nThe key of the tag.
\n ", + "required": true + }, + "Value": { + "shape_name": "TagValue", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 0, + "max_length": 256, + "documentation": " \nThe value of the tag.
\n " + } + }, + "documentation": "\nMetadata assigned to a load balancer consisting of key-value pair.
\nFor more information, see Tagging\n in the Elastic Load Balancing Developer Guide.
\n \n " + }, + "min_length": 1, + "documentation": "\nA list of tags for each load balancer.
\n \n ", + "required": true + } + }, + "documentation": "\n The input for the AddTags action \n " + }, + "output": { + "shape_name": "AddTagsOutput", + "type": "structure", + "members": {}, + "documentation": "\n The output for the AddTags action. \n " + }, + "errors": [ + { + "shape_name": "AccessPointNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\n\n The specified load balancer could not be found.\n
\n " + }, + { + "shape_name": "TooManyTagsException", + "type": "structure", + "members": {}, + "documentation": "\nThe quota for the number of tags that can be assigned to a load balancer has been reached.
\n " + }, + { + "shape_name": "DuplicateTagKeysException", + "type": "structure", + "members": {}, + "documentation": "\nThe same tag key specified multiple times.
\n " + } + ], + "documentation": "\nAdds one or more tags for the specified load balancer. Each load balancer can have a maximum of 10 tags. \n Each tag consists of a key and an optional value.
\n \nTag keys must be unique for each load balancer. If a tag with the same key is already associated with the load balancer, \n this action will update the value of the key.
\n \nFor more information, see Tagging\n in the Elastic Load Balancing Developer Guide.
\n\n The name associated with the load balancer.\n The name must be unique within your set of load balancers.\n
\n ", + "documentation": "\n\n The name associated with the load balancer.\n The name must be unique within your set of load balancers, \n must have a maximum of 32 characters, and must only contain alphanumeric characters or hyphens.\n
\n ", "required": true }, "Listeners": { @@ -440,7 +519,7 @@ }, "documentation": "\n\n The Listener data type.\n
\n " }, - "documentation": "\n\n A list of the following tuples:\n LoadBalancerPort, InstancePort, and Protocol.\n
\n ", + "documentation": "\n\n A list of the following tuples:\n Protocol, LoadBalancerPort, InstanceProtocol, InstancePort, and SSLCertificateId.\n
\n ", "required": true }, "AvailabilityZones": { @@ -476,7 +555,37 @@ "Scheme": { "shape_name": "LoadBalancerScheme", "type": "string", - "documentation": "\nThe type of a load balancer.
\n \nBy default, Elastic Load Balancing creates an Internet-facing load balancer\n with a publicly resolvable DNS name, which resolves to public IP addresses.\n For more informationabout Internet-facing and Internal load balancers, \n see Internet-facing and Internal Load Balancers.
\n \nSpecify the value internal for this option to create an internal load balancer\n with a DNS name that resolves to private IP addresses.
This option is only available for load balancers created within EC2-VPC.
\nThe type of a load balancer.
\n \nBy default, Elastic Load Balancing creates an Internet-facing load balancer\n with a publicly resolvable DNS name, which resolves to public IP addresses.\n For more information about Internet-facing and Internal load balancers, \n see Internet-facing and Internal Load Balancers.
\n \nSpecify the value internal for this option to create an internal load balancer\n with a DNS name that resolves to private IP addresses.
This option is only available for load balancers created within EC2-VPC.
\nThe key of the tag.
\n ", + "required": true + }, + "Value": { + "shape_name": "TagValue", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 0, + "max_length": 256, + "documentation": " \nThe value of the tag.
\n " + } + }, + "documentation": "\nMetadata assigned to a load balancer consisting of key-value pair.
\nFor more information, see Tagging\n in the Elastic Load Balancing Developer Guide.
\n \n " + }, + "min_length": 1, + "documentation": "\nA list of tags to assign to the load balancer.
\nFor more information about setting tags for your load balancer, see Tagging.
\n " } }, "documentation": "\n\n The input for the CreateLoadBalancer action.\n
\n " @@ -498,7 +607,7 @@ "shape_name": "DuplicateAccessPointNameException", "type": "structure", "members": {}, - "documentation": "\n\n Load balancer name already exists for this account.\n Please choose another name.\n
\n " + "documentation": "\n\n The load balancer name already exists for this account.\n Please choose another name.\n
\n " }, { "shape_name": "TooManyAccessPointsException", @@ -541,9 +650,21 @@ "type": "structure", "members": {}, "documentation": "\n\n Invalid value for scheme. Scheme can only be specified for load balancers in VPC. \n
\n " + }, + { + "shape_name": "TooManyTagsException", + "type": "structure", + "members": {}, + "documentation": "\nThe quota for the number of tags that can be assigned to a load balancer has been reached.
\n " + }, + { + "shape_name": "DuplicateTagKeysException", + "type": "structure", + "members": {}, + "documentation": "\nThe same tag key specified multiple times.
\n " } ], - "documentation": "\n\n Creates a new load balancer.\n
\n\n After the call has completed successfully, a new load balancer\n is created with a unique Domain Name Service (DNS) name. The DNS \n name includes the name of the AWS region in which the load balance \n was created. For example, if your load balancer was created in the\n United States, the DNS name might end with either of the following:
\nFor information about the AWS regions supported by Elastic Load Balancing, \n see Regions and Endpoints.
\n \nYou can create up to 20 load balancers per region per account.
\n \nElastic Load Balancing supports load balancing your Amazon EC2 instances launched\n within any one of the following platforms:
\nFor information on creating and managing your load balancers in EC2-Classic, \n see Deploy Elastic Load Balancing in Amazon EC2-Classic.
\nFor information on creating and managing your load balancers in EC2-VPC, \n see Deploy Elastic Load Balancing in Amazon VPC.
\n\n Creates a new load balancer.\n
\n\n After the call has completed successfully, a new load balancer\n is created with a unique Domain Name Service (DNS) name. The DNS \n name includes the name of the AWS region in which the load balance \n was created. For example, if your load balancer was created in the\n United States, the DNS name might end with either of the following:
\nFor information about the AWS regions supported by Elastic Load Balancing, \n see Regions and Endpoints.
\n \nYou can create up to 20 load balancers per region per account.
\n \nElastic Load Balancing supports load balancing your Amazon EC2 instances launched\n within any one of the following platforms:
\nFor information on creating and managing your load balancers in EC2-Classic, \n see Deploy Elastic Load Balancing in Amazon EC2-Classic.
\nFor information on creating and managing your load balancers in EC2-VPC, \n see Deploy Elastic Load Balancing in Amazon VPC.
\n\n The Listener data type.\n
\n " }, - "documentation": "\n\n A list of LoadBalancerPort, \n InstancePort, \n Protocol, and \n SSLCertificateId items. \t\n
\n A list of LoadBalancerPort, \n InstancePort, \n Protocol, \n InstanceProtocol, and \n SSLCertificateId items. \t\n
\n Requested configuration change is invalid.\n
\n " } ], - "documentation": "\n\n Creates one or more listeners on a load balancer for the specified port. \n If a listener with the given port does not already exist, it will be created; \n otherwise, the properties of the new listener must match the properties \n of the existing listener. \n
\nFor more information, see Add a Listener to Your Load Balancer \n in the Elastic Load Balancing Developer Guide.
\n \n\n Creates one or more listeners on a load balancer for the specified port. \n If a listener with the given port does not already exist, it will be created; \n otherwise, the properties of the new listener must match the properties \n of the existing listener. \n
\nFor more information, see Add a Listener to Your Load Balancer \n in the Elastic Load Balancing Developer Guide.
\n \n\n The name of the load balancer. \n
\n ", + "documentation": "\n\n The name of the load balancer. \n
\n ", "required": true }, "Instances": { @@ -935,10 +1056,10 @@ }, "documentation": "\n\n The Instance data type.\n
\n " }, - "documentation": "\n\n A list of instance IDs whose states are being queried.\n
\n " + "documentation": "\n\n A list of instance IDs whose states are being queried.\n
\n " } }, - "documentation": "\n\n The input for the DescribeEndPointState action.\n
\n " + "documentation": "\n\n The input for the DescribeEndPointState action.\n
\n " }, "output": { "shape_name": "DescribeEndPointStateOutput", @@ -959,7 +1080,7 @@ "State": { "shape_name": "State", "type": "string", - "documentation": "\nSpecifies the current state of the instance.
\n \nValid value: InService|OutOfService
Specifies the current state of the instance.
\n \nValid value: InService|OutOfService|Unknown
\n The InstanceState data type.\n
\n " }, - "documentation": "\n\n A list containing health information\n for the specified instances.\n
\n " + "documentation": "\n\n A list containing health information\n for the specified instances.\n
\n " } }, - "documentation": "\n\t\t\n\t\tThe output for the DescribeInstanceHealth action.\n\t\t
\n " + "documentation": "\n\n The output for the DescribeInstanceHealth action.\n
\n " }, "errors": [ { @@ -993,7 +1114,7 @@ "documentation": "\n\n The specified EndPoint is not valid.\n
\n " } ], - "documentation": "\n\n Returns the current state of the specified instances registered with the specified load balancer.\n If no instances are specified, the state of all the instances registered with the load balancer is returned.\n
\n\n Returns the current state of the specified instances registered with the specified load balancer.\n If no instances are specified, the state of all the instances registered with the load balancer is returned.\n
\nThe name of the load balancer.
\n ", + "documentation": "\nThe name of the load balancer.
\n ", "required": true } }, @@ -1057,7 +1178,7 @@ "documentation": "\nThe logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. \n If the prefix is not provided, the log is placed at the root level of the bucket.
The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket you specify.
\nFor more information, see Enable Access Logs.
\n " + "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.
\nFor more information, see Enable Access Logs.
\n " }, "ConnectionDraining": { "shape_name": "ConnectionDraining", @@ -1076,9 +1197,24 @@ } }, "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
\nFor more information, see Enable Connection Draining.
\n \n " + }, + "ConnectionSettings": { + "shape_name": "ConnectionSettings", + "type": "structure", + "members": { + "IdleTimeout": { + "shape_name": "IdleTimeout", + "type": "integer", + "min_length": 1, + "max_length": 3600, + "documentation": "\nSpecifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.
\n ", + "required": true + } + }, + "documentation": "\nThe name of the load balancer attribute.
\nBy default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
\n " } }, - "documentation": "\nThe load balancer attributes structure.
\n " + "documentation": "\nThe load balancer attributes structure.
\n " } }, "documentation": "\nThe following element is returned in a structure named DescribeLoadBalancerAttributesResult.
The specified load balancer attribute could not be found.
\n " } ], - "documentation": "\nReturns detailed information about all of the attributes associated with the specified load balancer.
\nReturns detailed information about all of the attributes associated with the specified load balancer.
\n\n An optional parameter reserved for future use.\n
\n " + "documentation": "\n\n An optional parameter used for pagination of results from this call. If specified, the response includes only records beyond the marker. \n
\n " + }, + "PageSize": { + "shape_name": "PageSize", + "type": "integer", + "min_length": 1, + "max_length": 400, + "documentation": " \n\n The number of results returned in each page. The default is 400. You cannot specify a page size greater than 400 or less than 1. \n
\n " } }, - "documentation": "\n\t\t\n\t\tThe input for the DescribeLoadBalancers action.\n\t\t
\n " + "documentation": "\n\n The input for the DescribeLoadBalancers action.\n
\n " }, "output": { "shape_name": "DescribeAccessPointsOutput", @@ -1621,10 +1764,10 @@ "NextMarker": { "shape_name": "Marker", "type": "string", - "documentation": "\n\n An optional parameter reserved for future use.\n
\n " + "documentation": "\n\n Specifies the value of next marker if the request returned more than one page of results. \n
\n " } }, - "documentation": "\n\t\t\n\t\tThe output for the DescribeLoadBalancers action.\n\t\t
\n " + "documentation": "\n\n The output for the DescribeLoadBalancers action.\n
\n " }, "errors": [ { @@ -1634,7 +1777,7 @@ "documentation": "\n\n The specified load balancer could not be found.\n
\n " } ], - "documentation": "\n\n Returns detailed configuration information for all the load balancers created for the account.\n If you specify load balancer names, the action returns configuration information of the specified\n load balancers.
\n\n Returns detailed configuration information for all the load balancers created for the account.\n If you specify load balancer names, the action returns configuration information of the specified\n load balancers.
\n\n The names of the load balancers. \n
\n ", + "required": true + } + }, + "documentation": "\n\n The input for the DescribeTags action.\n
\n " + }, + "output": { + "shape_name": "DescribeTagsOutput", + "type": "structure", + "members": { + "TagDescriptions": { + "shape_name": "TagDescriptions", + "type": "list", + "members": { + "shape_name": "TagDescription", + "type": "structure", + "members": { + "LoadBalancerName": { + "shape_name": "AccessPointName", + "type": "string", + "documentation": "\nThe name of the load balancer.
\n " + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 1, + "max_length": 128, + "documentation": "\nThe key of the tag.
\n ", + "required": true + }, + "Value": { + "shape_name": "TagValue", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 0, + "max_length": 256, + "documentation": " \nThe value of the tag.
\n " + } + }, + "documentation": "\nMetadata assigned to a load balancer consisting of key-value pair.
\nFor more information, see Tagging\n in the Elastic Load Balancing Developer Guide.
\n \n " + }, + "min_length": 1, + "documentation": "\nList of tags associated with the load balancer.
\n " + } + }, + "documentation": "\nThe descriptions of all the tags associated with load balancer.
\n " + }, + "documentation": "\n\n A list of tag description structures.\n
\n " + } + }, + "documentation": "\n\n The output for the DescribeTags action.\n
\n " + }, + "errors": [ + { + "shape_name": "AccessPointNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\n\n The specified load balancer could not be found.\n
\n " + } + ], + "documentation": "\nDescribes the tags associated with one or more load balancers.
\nThe logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. \n If the prefix is not provided, the log is placed at the root level of the bucket.
The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket you specify.
\nFor more information, see Enable Access Logs.
\n " + "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.
\nFor more information, see Enable Access Logs.
\n " }, "ConnectionDraining": { "shape_name": "ConnectionDraining", @@ -1887,9 +2116,24 @@ } }, "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
\nFor more information, see Enable Connection Draining.
\n \n " + }, + "ConnectionSettings": { + "shape_name": "ConnectionSettings", + "type": "structure", + "members": { + "IdleTimeout": { + "shape_name": "IdleTimeout", + "type": "integer", + "min_length": 1, + "max_length": 3600, + "documentation": "\nSpecifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.
\n ", + "required": true + } + }, + "documentation": "\nThe name of the load balancer attribute.
\nBy default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
\n " } }, - "documentation": "\nAttributes of the load balancer.
\n ", + "documentation": "\nAttributes of the load balancer.
\n ", "required": true } }, @@ -1947,7 +2191,7 @@ "documentation": "\nThe logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. \n If the prefix is not provided, the log is placed at the root level of the bucket.
The name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket you specify.
\nFor more information, see Enable Access Logs.
\n " + "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer captures detailed information of all the requests and delivers the information to the Amazon S3 bucket that you specify.
\nFor more information, see Enable Access Logs.
\n " }, "ConnectionDraining": { "shape_name": "ConnectionDraining", @@ -1966,6 +2210,21 @@ } }, "documentation": "\nThe name of the load balancer attribute.\n If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy back-end instance.
\nFor more information, see Enable Connection Draining.
\n \n " + }, + "ConnectionSettings": { + "shape_name": "ConnectionSettings", + "type": "structure", + "members": { + "IdleTimeout": { + "shape_name": "IdleTimeout", + "type": "integer", + "min_length": 1, + "max_length": 3600, + "documentation": "\nSpecifies the time (in seconds) the connection is allowed to be idle (no data has been sent over the connection)\n before it is closed by the load balancer.
\n ", + "required": true + } + }, + "documentation": "\nThe name of the load balancer attribute.
\nBy default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. \n If the ConnectionSettings attribute is set, Elastic Load Balancing will allow the connections to \n remain idle (no data is sent over the connection) for the specified duration.
For more information, see Configure Idle Connection Timeout.
\n " } }, "documentation": "\nThe LoadBalancerAttributes data type.
\n Requested configuration change is invalid.\n
\n " } ], - "documentation": "\nModifies the attributes of a specified load balancer.
\nYou can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and \n CrossZoneLoadBalancing by either enabling or disabling them.
For information on cross-zone load balancing, see Request Routing and for information on connection draining, see Connection Draining\n in the Concepts section of the\n Elastic Load Balancer Developer Guide. For information on access logs, see Access Logs.
\n \nModifies the attributes of a specified load balancer.
\nYou can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and \n CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute \n ConnectionSettings by specifying an idle connection timeout value for your load balancer.
For more information, see the following:
\n \n \n \n \n\n Adds new instances to the load balancer.\n
\n\n Once the instance is registered, it starts receiving traffic\n and requests from the load balancer. Any instance that is not\n in any of the Availability Zones registered for the load balancer\n will be moved to the OutOfService state. It will move to the\n InService state when the Availability Zone is added to the load balancer.\n
\nWhen an instance registered with a load balancer is stopped and then restarted, \n the IP addresses associated with the instance changes. Elastic Load Balancing \n cannot recognize the new IP address, which prevents it from routing traffic to\n the instances. We recommend that you de-register your Amazon EC2 instances from\n your load balancer after you stop your instance, and then register the load \n balancer with your instance after you've restarted. To de-register your instances \n from load balancer, use DeregisterInstancesFromLoadBalancer action.
\nFor more information, see De-register and Register Amazon EC2 Instances \n in the Elastic Load Balancing Developer Guide.
\nYou can use DescribeLoadBalancers or DescribeInstanceHealth action to check the state of the newly registered instances.
\nThe name of the load balancer. You can specify a maximum of one load balancer name.
\n ", + "required": true + }, + "Tags": { + "shape_name": "TagKeyList", + "type": "list", + "members": { + "shape_name": "TagKeyOnly", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "min_length": 1, + "max_length": 128, + "documentation": "\nThe name of the key.
\n " + } + }, + "documentation": "\nThe key of a tag to be removed.
\n " + }, + "min_length": 1, + "documentation": "\nA list of tag keys to remove.
\n ", + "required": true + } + }, + "documentation": "\n\n The input for the RemoveTags action.\n
\n " + }, + "output": { + "shape_name": "RemoveTagsOutput", + "type": "structure", + "members": {}, + "documentation": "\n\n The output for the RemoveTags action.\n
\n " + }, + "errors": [ + { + "shape_name": "AccessPointNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\n\n The specified load balancer could not be found.\n
\n " + } + ], + "documentation": "\nRemoves one or more tags from the specified load balancer.
\nThe input for the SetLoadBalancerPoliciesForBackendServer action.
\n " }, "output": { "shape_name": "SetLoadBalancerPoliciesForBackendServerOutput", diff --git a/botocore/data/aws/emr/2009-03-31.json b/botocore/data/aws/emr/2009-03-31.json index 2c3acf9a..364de1a7 100644 --- a/botocore/data/aws/emr/2009-03-31.json +++ b/botocore/data/aws/emr/2009-03-31.json @@ -9,7 +9,7 @@ "timestamp_format": "unixTimestamp", "endpoint_prefix": "elasticmapreduce", "xmlnamespace": "http://elasticmapreduce.amazonaws.com/doc/2009-03-31", - "documentation": "\nThis is the Amazon Elastic MapReduce API Reference. This guide provides descriptions and\n samples of the Amazon Elastic MapReduce APIs.
\n\nAmazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.
\n\n ", + "documentation": "\n\nAmazon Elastic MapReduce (Amazon EMR) is a web service that makes it easy to process large amounts of\n data efficiently. Amazon EMR uses Hadoop processing combined with several AWS\n products to do tasks such as web indexing, data mining, log file analysis, machine\n learning, scientific simulation, and data warehousing.
\n\n ", "operations": { "AddInstanceGroups": { "name": "AddInstanceGroups", @@ -588,7 +588,7 @@ "ServiceRole": { "shape_name": "String", "type": "string", - "documentation": "\nThe IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf.
\n " + "documentation": "\nThe IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
\n " } }, "documentation": "\nThis output contains the details for the requested cluster.
\n " @@ -1252,7 +1252,7 @@ "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, - "documentation": "\nThe IAM role that was specified when the job flow was launched. Amazon ElasticMapReduce will assume this role to work with AWS resources on your behalf.
\n " + "documentation": "\nThe IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
\n " } }, "documentation": "\nA description of a job flow.
\n " @@ -2858,7 +2858,7 @@ "pattern": "[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*", "min_length": 0, "max_length": 10280, - "documentation": "\nIAM role that Amazon ElasticMapReduce will assume to work with AWS resources on your behalf. You may set this parameter to the name of an existing IAM role.
\n " + "documentation": "\nThe IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.
\n " }, "Tags": { "shape_name": "TagList", diff --git a/botocore/data/aws/iam/2010-05-08.json b/botocore/data/aws/iam/2010-05-08.json index 86db36d9..3da250b5 100644 --- a/botocore/data/aws/iam/2010-05-08.json +++ b/botocore/data/aws/iam/2010-05-08.json @@ -8,7 +8,7 @@ "global_endpoint": "iam.amazonaws.com", "endpoint_prefix": "iam", "xmlnamespace": "https://iam.amazonaws.com/doc/2010-05-08/", - "documentation": "\n\t\tAWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions\n\t\t\tunder your AWS account. This guide provides descriptions of the IAM API. For general\n\t\t\tinformation about IAM, see AWS Identity\n\t\t\t\tand Access Management (IAM). For the user guide for IAM, see Using IAM.
\n\t\t\n\t\tUsing the IAM Query API, you make direct calls to the IAM web service. IAM supports\n\t\t\tGET and POST requests for all actions. That is, the API does not require you to use GET for\n\t\t\tsome actions and POST for others. However, GET requests are subject to the limitation size of\n\t\t\ta URL; although this limit is browser dependent, a typical limit is 2048 bytes. Therefore, for\n\t\t\toperations that require larger sizes, you must use a POST request.
\n\t\t\n\t\tSigning Requests
Requests must be signed using an access key ID and a secret\n\t\t\taccess key. We strongly recommend that you do not use your AWS account access key ID and\n\t\t\tsecret access key for everyday work with IAM. You can use the access key ID and secret access\n\t\t\tkey for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials\n\t\t\tand use those to sign requests.
To sign requests, we recommend that you use Signature Version 4. If\n\t\t\tyou have an existing application that uses Signature Version 2, you do not have to update it\n\t\t\tto use Signature Version 4. However, some operations now require Signature Version 4. The\n\t\t\tdocumentation for operations that require version 4 indicate this requirement.
\n\t\t\n\n\t\tAdditional Resources
\n\t\tFor more information, see the following:
AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions\n\t\t\tunder your AWS account. This guide provides descriptions of the IAM API. For general\n\t\t\tinformation about IAM, see AWS Identity\n\t\t\t\tand Access Management (IAM). For the user guide for IAM, see Using IAM.
\n\n\t\tUsing the IAM Query API, you make direct calls to the IAM web service. IAM supports\n\t\t\tGET and POST requests for all actions. That is, the API does not require you to use GET for\n\t\t\tsome actions and POST for others. However, GET requests are subject to the limitation size of\n\t\t\ta URL. Therefore, for operations that require larger sizes, use a POST request.
\n\n\t\tSigning Requests
\n\t\tRequests must be signed using an access key ID and a secret\n\t\taccess key. We strongly recommend that you do not use your AWS account access key ID and\n\t\tsecret access key for everyday work with IAM. You can use the access key ID and secret access\n\t\tkey for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials\n\t\tand use those to sign requests.\n\t\t
\n\n\t\tTo sign requests, we recommend that you use Signature Version 4. If\n\t\t\tyou have an existing application that uses Signature Version 2, you do not have to update it\n\t\t\tto use Signature Version 4. However, some operations now require Signature Version 4. The\n\t\t\tdocumentation for operations that require version 4 indicate this requirement.
\n\n\t\tRecording API requests
\n\t\t\n\t\t\tIAM supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers\n\t\t\tlog files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what\n\t\t\trequests were successfully made to IAM, who made the request, when it was made, and so on. To learn more about\n\t\t\tCloudTrail, including how to turn it on and find your log files, see the\n\t\t\tAWS CloudTrail User Guide.\n\t\t
\n\n\t\tAdditional Resources
\n\t\tFor more information, see the following:
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -58,7 +58,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -70,7 +70,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -114,7 +114,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -126,7 +126,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -147,7 +147,7 @@ "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, - "documentation": null, + "documentation": "\nThe IAM users's current password.
\n ", "required": true }, "NewPassword": { @@ -157,11 +157,11 @@ "max_length": 128, "pattern": "[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", "sensitive": true, - "documentation": null, + "documentation": "\nThe new password. The new password must conform to the AWS account's password policy, if one exists.
\n ", "required": true } }, - "documentation": null + "documentation": " " }, "output": null, "errors": [ @@ -172,7 +172,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -196,7 +196,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -208,13 +208,25 @@ "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" + }, + { + "shape_name": "PasswordPolicyViolationException", + "type": "structure", + "members": { + "message": { + "shape_name": "passwordPolicyViolationMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\n\t\tThe request was rejected because the provided password did not meet the requirements imposed\n\t\t\tby the account password policy.
\n\t" } ], - "documentation": "\n\t\tChanges the password of the IAM user calling ChangePassword. The root account\n\t\t\tpassword is not affected by this action. For information about modifying passwords, see Managing Passwords.
Changes the password of the IAM user calling ChangePassword. The root account\n\t\t\tpassword is not affected by this action. For information about modifying passwords, see Managing Passwords in the Using IAM guide.
The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -308,13 +320,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tCreates a new AWS secret access key and corresponding AWS access key ID for the specified\n\t\t\tuser. 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\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.
\n\t\tFor information about limits on the number of keys you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tCreates a new AWS secret access key and corresponding AWS access key ID for the specified\n\t\t\tuser. 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\n\t\t\taccess key ID signing the request. Because this action works for access keys under the AWS\n\t\t\taccount, you can use this API to manage root credentials even if the AWS account has no\n\t\t\tassociated users.
\n\t\tFor information about limits on the number of keys you can create, see Limitations on IAM Entities in the Using IAM guide.
\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -355,13 +367,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tThis action creates an alias for your AWS account. For information about using an AWS account\n\t\t\talias, see Using an Alias for Your AWS Account ID in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis action creates an alias for your AWS account. For information about using an AWS account\n\t\t\talias, see Using an Alias for Your AWS Account ID in the Using IAM guide.
\n\t\tThe path to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\t\tThe path to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" }, "GroupName": { "shape_name": "groupNameType", @@ -403,7 +415,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "GroupName": { @@ -421,7 +433,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -429,7 +441,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -453,7 +465,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -465,7 +477,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -477,13 +489,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tCreates a new group.
\n\t\tFor information about the number of groups you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tCreates a new group.
\n\t\tFor information about the number of groups you can create, see Limitations on IAM Entities in the Using IAM guide.
\n\t\tThe path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\t\tThe path to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" } }, "documentation": " " @@ -525,7 +537,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "InstanceProfileName": { @@ -543,7 +555,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -551,7 +563,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -573,7 +585,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -591,7 +603,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -599,7 +611,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -637,7 +649,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -649,13 +661,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tCreates a new instance profile. For information about instance profiles, go to About Instance\n\t\t\t\tProfiles.
\n\t\tFor information about the number of instance profiles you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tCreates a new instance profile. For information about instance profiles, go to About Instance\n\t\t\t\tProfiles.
\n\t\tFor information about the number of instance profiles you can create, see Limitations on IAM Entities in the Using IAM guide.
\n\t\tThe new password for the user name.
\n\t", + "documentation": "\n\t\tThe new password for the user.
\n\t", "required": true + }, + "PasswordResetRequired": { + "shape_name": "booleanType", + "type": "boolean", + "documentation": "\nSpecifies whether the user is required to set a new password on next sign-in.
\n " } }, "documentation": " " @@ -699,7 +716,7 @@ "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", - "documentation": "\n\t\tThe name of the user, which can be used for signing into the AWS Management Console.
\n\t", + "documentation": "\n\t\tThe name of the user, which can be used for signing in to the AWS Management Console.
\n\t", "required": true }, "CreateDate": { @@ -707,6 +724,11 @@ "type": "timestamp", "documentation": "\n\t\tThe date when the password for the user was created.
\n\t", "required": true + }, + "PasswordResetRequired": { + "shape_name": "booleanType", + "type": "boolean", + "documentation": "\nSpecifies whether the user is required to set a new password on next sign-in.
\n " } }, "documentation": "\n\t\tThe user name and password create date.
\n\t", @@ -723,7 +745,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -735,7 +757,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -759,13 +781,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tCreates a password for the specified user, giving the user the ability to access AWS services\n\t\t\tthrough the AWS Management Console. For more information about managing passwords, see Managing Passwords in Using IAM.
\n\t\tCreates a password for the specified user, giving the user the ability to access AWS services\n\t\t\tthrough the AWS Management Console. For more information about managing passwords, see Managing Passwords in the Using IAM guide.
\n\t\tThe path to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\t\tThe path to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" }, "RoleName": { "shape_name": "roleNameType", @@ -816,7 +838,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -834,7 +856,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -842,7 +864,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -874,7 +896,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -886,7 +908,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -898,13 +920,13 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" } ], - "documentation": "\n\t\tCreates a new role for your AWS account. For more information about roles, go to Working with Roles.\n\t\t\tFor information about limitations on role names and the number of roles you can create, go to\n\t\t\t\tLimitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThe policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded\n\t\t\taccording to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.\n\t\t\tCurrently, only EC2 instances can assume roles.
\n\t\tCreates a new role for your AWS account. For more information about roles, go to Working with Roles.\n\t\t\tFor information about limitations on role names and the number of roles you can create, go to\n\t\t\t\tLimitations on IAM Entities in the Using IAM guide.
\n\t\tThe example policy grants permission to an EC2 instance to assume the role. The policy is URL-encoded\n\t\t\taccording to RFC 3986. For more information about RFC 3986, go to http://www.faqs.org/rfcs/rfc3986.html.
\n\t\tAn XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP.
\n\t\t\n\t\tFor more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tSecurity Credentials guide.
\n\t\t\n\t", + "documentation": "\n\t\tAn XML document generated by an identity provider (IdP) that supports SAML 2.0. The document\n\t\t\tincludes the issuer's name, expiration information, and keys that can be used to validate the\n\t\t\tSAML authentication response (assertions) that are received from the IdP. You must generate\n\t\t\tthe metadata document using the identity management software that is used as your\n\t\t\torganization's IdP.
\n\n\t\tFor more information, see Creating Temporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tSecurity Credentials guide.
\n\n\t", "required": true }, "Name": { @@ -966,7 +988,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -978,13 +1000,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tCreates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
\n\t\tThe SAML provider that you create with this operation can be used as a principal in a role's\n\t\t\ttrust policy to establish a trust relationship between AWS and a SAML identity provider. You\n\t\t\tcan create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one\n\t\t\tthat supports API access to AWS.
\n\t\t\n\t\tWhen you create the SAML provider, you upload an a SAML metadata document that you get from\n\t\t\tyour IdP and that includes the issuer's name, expiration information, and keys that can be\n\t\t\tused to validate the SAML authentication response (assertions) that are received from the IdP.\n\t\t\tYou must generate the metadata document using the identity management software that is used as\n\t\t\tyour organization's IdP.
\n\t\t\n\t\tFor more information, see Giving Console Access Using SAML and Creating\n\t\t\t\tTemporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tCredentials guide.
\n\t\tCreates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.
\n\t\tThe SAML provider that you create with this operation can be used as a principal in a role's\n\t\t\ttrust policy to establish a trust relationship between AWS and a SAML identity provider. You\n\t\t\tcan create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one\n\t\t\tthat supports API access to AWS.
\n\n\t\tWhen you create the SAML provider, you upload an a SAML metadata document that you get from\n\t\t\tyour IdP and that includes the issuer's name, expiration information, and keys that can be\n\t\t\tused to validate the SAML authentication response (assertions) that are received from the IdP.\n\t\t\tYou must generate the metadata document using the identity management software that is used as\n\t\t\tyour organization's IdP.
\n\n\n\t\tFor more information, see Giving Console Access Using SAML and Creating\n\t\t\t\tTemporary Security Credentials for SAML Federation in the Using Temporary\n\t\t\t\tCredentials guide.
\n\t\tThe path for the user name. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\t\tThe path for the user name. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" }, "UserName": { "shape_name": "userNameType", @@ -1026,7 +1048,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -1044,7 +1066,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -1052,7 +1074,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -1075,7 +1097,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1087,7 +1109,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -1099,13 +1121,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tCreates a new user for your AWS account.
\n\t\tFor information about limitations on the number of users you can create, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tCreates a new user for your AWS account.
\n\t\tFor information about limitations on the number of users you can create, see Limitations on IAM Entities in the Using IAM guide.
\n\t\tThe path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\t\tThe path for the virtual MFA device. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" }, "VirtualMFADeviceName": { "shape_name": "virtualMFADeviceName", @@ -1130,7 +1152,7 @@ "required": true } }, - "documentation": null + "documentation": " " }, "output": { "shape_name": "CreateVirtualMFADeviceResponse", @@ -1153,7 +1175,7 @@ "shape_name": "BootstrapDatum", "type": "blob", "sensitive": true, - "documentation": "\n\t\tThe Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -1189,7 +1211,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -1197,7 +1219,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -1229,7 +1251,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1241,13 +1263,13 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" } ], - "documentation": "\n\t\tCreates 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\n\t\t\tcreating and working with virtual MFA devices, go to Using a Virtual MFA Device in Using AWS Identity and Access Management.
\n\t\tFor information about limits on the number of MFA devices you can create, see Limitations on Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tCreates 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\n\t\t\tcreating and working with virtual MFA devices, go to Using a Virtual MFA Device in the Using IAM guide.
\n\t\tFor information about limits on the number of MFA devices you can create, see Limitations on Entities in the Using IAM guide.
\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" @@ -1297,7 +1319,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1309,7 +1331,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1352,7 +1374,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1364,7 +1386,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1399,7 +1421,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1411,13 +1433,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tDeletes the specified AWS account alias. For information about using an AWS account alias,\n\t\t\tsee Using an\n\t\t\t\tAlias for Your AWS Account ID in Using AWS Identity and Access Management.
\n\t\tDeletes the specified AWS account alias. For information about using an AWS account alias,\n\t\t\tsee Using an\n\t\t\t\tAlias for Your AWS Account ID in the Using IAM guide.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": { + "message": { + "shape_name": "limitExceededMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], "documentation": "\n\t\tDeletes the password policy for the AWS account.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1478,7 +1512,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -1490,7 +1524,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1534,7 +1568,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1546,7 +1580,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1581,7 +1615,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1593,7 +1627,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -1605,7 +1639,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1640,7 +1674,7 @@ "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" @@ -1652,7 +1686,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1664,7 +1698,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1699,7 +1733,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1711,7 +1745,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -1723,7 +1757,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1756,7 +1790,7 @@ "required": true } }, - "documentation": null + "documentation": " " }, "output": null, "errors": [ @@ -1767,7 +1801,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1779,7 +1813,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1817,9 +1851,33 @@ } }, "documentation": null + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": { + "message": { + "shape_name": "limitExceededMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" + }, + { + "shape_name": "NoSuchEntityException", + "type": "structure", + "members": { + "message": { + "shape_name": "noSuchEntityMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tDeletes a SAML provider.
\n\t\tDeleting the provider does not update any roles that reference the SAML provider as a\n\t\t\tprincipal in their trust policies. Any attempt to assume a role that references a SAML\n\t\t\tprovider that has been deleted will fail.
\n\t\tDeletes a SAML provider.
\n\t\tDeleting the provider does not update any roles that reference the SAML provider as a\n\t\t\tprincipal in their trust policies. Any attempt to assume a role that references a SAML\n\t\t\tprovider that has been deleted will fail.
\n\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1860,7 +1918,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -1872,7 +1930,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1915,7 +1973,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1927,7 +1985,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1962,7 +2020,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -1974,7 +2032,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -1986,7 +2044,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -2030,7 +2088,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2042,7 +2100,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -2066,7 +2124,7 @@ "required": true } }, - "documentation": null + "documentation": " " }, "output": null, "errors": [ @@ -2077,7 +2135,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2089,7 +2147,7 @@ "message": { "shape_name": "deleteConflictMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to delete a resource that has attached\n\t\t\tsubordinate entities. The error message describes these entities.
\n\t" @@ -2101,13 +2159,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tDeletes a virtual MFA device.
\n\t\tDeletes a virtual MFA device.
\n\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -2175,7 +2233,7 @@ "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" @@ -2187,7 +2245,7 @@ "message": { "shape_name": "invalidAuthenticationCodeMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.
\n\t" @@ -2199,7 +2257,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -2211,7 +2269,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2219,6 +2277,47 @@ ], "documentation": "\n\t\tEnables the specified MFA device and associates it with the specified user name. When\n\t\t\tenabled, the MFA device is required for every subsequent login by the user name associated\n\t\t\twith the device.
\n\t\tInformation about the state of a credential report.
\n " + }, + "Description": { + "shape_name": "ReportStateDescriptionType", + "type": "string", + "documentation": "\nInformation about the credential report.
\n " + } + }, + "documentation": "\nContains the result of a successful invocation of the GenerateCredentialReport action.
\n " + }, + "errors": [ + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": { + "message": { + "shape_name": "limitExceededMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" + } + ], + "documentation": "\nGenerates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.
\n " + }, "GetAccountPasswordPolicy": { "name": "GetAccountPasswordPolicy", "input": null, @@ -2260,17 +2359,34 @@ "AllowUsersToChangePassword": { "shape_name": "booleanType", "type": "boolean", - "documentation": "\n\t\tSpecifies whether to allow IAM users to change their own password.
\n\t" + "documentation": "\n\t\tSpecifies whether IAM users are allowed to change their own password.
\n\t" }, "ExpirePasswords": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\nSpecifies whether IAM users are required to change their password after a specified number of days.
\n " }, "MaxPasswordAge": { "shape_name": "maxPasswordAgeType", "type": "integer", - "documentation": null + "min_length": 1, + "max_length": 1095, + "box": true, + "documentation": "\nThe number of days that an IAM user password is valid.
\n " + }, + "PasswordReusePrevention": { + "shape_name": "passwordReusePreventionType", + "type": "integer", + "min_length": 1, + "max_length": 24, + "box": true, + "documentation": "\nSpecifies the number of previous passwords that IAM users are prevented from reusing.
\n " + }, + "HardExpiry": { + "shape_name": "booleanObjectType", + "type": "boolean", + "box": true, + "documentation": "\nSpecifies whether IAM users are prevented from setting a new password after their password has expired.
\n " } }, "documentation": "\n\t\tThe PasswordPolicy data type contains information about the account password policy.
\n\t\tThis data type is used as a response element in the action GetAccountPasswordPolicy.\n\t\t
\n\t", @@ -2287,13 +2403,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tRetrieves the password policy for the AWS account. For more information about using a\n\t\t\tpassword policy, go to Managing an\n\t\t\t\tIAM Password Policy.
\n\t\tRetrieves the password policy for the AWS account. For more information about using a\n\t\t\tpassword policy, go to Managing an\n\t\t\t\tIAM Password Policy.
\n\t\tContains the result of a successful invocation of the GetAccountSummary action.
\n\t" }, "errors": [], - "documentation": "\n\t\tRetrieves account level information about account entity usage and IAM quotas.
\n\t\tFor information about limitations on IAM entities, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tRetrieves account level information about account entity usage and IAM quotas.
\n\t\tFor information about limitations on IAM entities, see Limitations on IAM Entities in the Using IAM guide.
\n\t\tContains the credential report. The report is Base64-encoded.
\n " + }, + "ReportFormat": { + "shape_name": "ReportFormatType", + "type": "string", + "enum": [ + "text/csv" + ], + "documentation": "\nThe format (MIME type) of the credential report.
\n " + }, + "GeneratedTime": { + "shape_name": "dateType", + "type": "timestamp", + "documentation": "\nThe time and date when the credential report was created, in ISO 8601 date-time format.
\n " + } + }, + "documentation": "\nContains the result of a successful invocation of the GetCredentialReport action.
\n " + }, + "errors": [ + { + "shape_name": "CredentialReportNotPresentException", + "type": "structure", + "members": { + "message": { + "shape_name": "credentialReportNotPresentExceptionMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.
\n " + }, + { + "shape_name": "CredentialReportExpiredException", + "type": "structure", + "members": { + "message": { + "shape_name": "credentialReportExpiredExceptionMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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 Using IAM guide.
\n " + }, + { + "shape_name": "CredentialReportNotReadyException", + "type": "structure", + "members": { + "message": { + "shape_name": "credentialReportNotReadyExceptionMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request was rejected because the credential report is still being generated.
\n " + } + ], + "documentation": "\nRetrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the Using IAM guide.
\n " }, "GetGroup": { "name": "GetGroup", @@ -2386,7 +2570,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "GroupName": { @@ -2404,7 +2588,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -2412,7 +2596,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -2438,7 +2622,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -2456,7 +2640,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -2464,7 +2648,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -2503,19 +2687,22 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tReturns a list of users that are in the specified group. You can paginate the results using\n\t\t\tthe MaxItems and Marker parameters.
Returns a list of users that are in the specified group. You can paginate the results using\n\t\t\tthe MaxItems and Marker parameters.
The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2628,7 +2815,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "InstanceProfileName": { @@ -2646,7 +2833,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -2654,7 +2841,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -2676,7 +2863,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -2694,7 +2881,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -2702,7 +2889,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -2740,7 +2927,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2780,7 +2967,7 @@ "min_length": 1, "max_length": 64, "pattern": "[\\w+=,.@-]*", - "documentation": "\n\t\tThe name of the user, which can be used for signing into the AWS Management Console.
\n\t", + "documentation": "\n\t\tThe name of the user, which can be used for signing in to the AWS Management Console.
\n\t", "required": true }, "CreateDate": { @@ -2788,6 +2975,11 @@ "type": "timestamp", "documentation": "\n\t\tThe date when the password for the user was created.
\n\t", "required": true + }, + "PasswordResetRequired": { + "shape_name": "booleanType", + "type": "boolean", + "documentation": "\nSpecifies whether the user is required to set a new password on next sign-in.
\n " } }, "documentation": "\n\t\tUser name and password create date for the user.
\n\t", @@ -2804,7 +2996,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -2844,7 +3036,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -2862,7 +3054,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -2870,7 +3062,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -2902,13 +3094,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tRetrieves information about the specified role, including the role's path, GUID, ARN, and the\n\t\t\tpolicy granting permission to EC2 to assume the role. For more information about ARNs, go to\n\t\t\t\tARNs. For more information about roles, go to Working with\n\t\t\tRoles.
\n\t\tThe returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.
\n\t\tRetrieves information about the specified role, including the role's path, GUID, ARN, and the\n\t\t\tpolicy granting permission to assume the role. For more information about ARNs, go to\n\t\t\t\tARNs. For more information about roles, go to Working with\n\t\t\tRoles.
\n\t\tThe returned policy is URL-encoded according to RFC 3986. For more information about RFC\n\t\t\t3986, go to http://www.faqs.org/rfcs/rfc3986.html.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -3036,7 +3228,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -3054,7 +3246,7 @@ "documentation": null } ], - "documentation": "\n\t\tReturns the SAML provider metadocument that was uploaded when the provider was created or\n\t\t\tupdated.
\n\t\tReturns the SAML provider metadocument that was uploaded when the provider was created or\n\t\t\tupdated.
\n\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "ServerCertificateName": { @@ -3110,7 +3302,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3118,13 +3310,18 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", - "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n\t" + "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n " + }, + "Expiration": { + "shape_name": "dateType", + "type": "timestamp", + "documentation": "\nThe date on which the certificate is set to expire.
\n " } }, "documentation": "\n\t\tThe meta information of the server certificate, such as its name, path, ID, and ARN.
\n\t", @@ -3162,13 +3359,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tRetrieves information about the specified server certificate.
\n\t\tRetrieves information about the specified server certificate.
\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -3219,7 +3416,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3227,7 +3424,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -3251,7 +3448,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -3328,7 +3525,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -3439,13 +3636,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tReturns information about the access key IDs associated with the specified user. If there are\n\t\t\tnone, the action returns an empty list.
\n\t\tAlthough each user is limited to a small number of keys, you can still paginate the results\n\t\t\tusing the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
Returns information about the access key IDs associated with the specified user. If there are\n\t\t\tnone, the action returns an empty list.
\n\t\tAlthough each user is limited to a small number of keys, you can still paginate the results\n\t\t\tusing the MaxItems and Marker parameters.
If the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
Contains the result of a successful invocation of the ListAccountAliases action.
\n\t" }, "errors": [], - "documentation": "\n\t\tLists the account aliases associated with the account. For information about using an AWS\n\t\t\taccount alias, see Using an Alias for Your AWS Account ID in Using AWS Identity and\n\t\t\t\tAccess Management.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
Lists the account aliases associated with the account. For information about using an AWS\n\t\t\taccount alias, see Using an Alias for Your AWS Account ID in the Using IAM guide.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -3664,7 +3861,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "GroupName": { @@ -3682,7 +3879,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3690,7 +3887,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -3782,7 +3979,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the group. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "GroupName": { @@ -3800,7 +3997,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the group. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3808,7 +4005,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -3847,13 +4044,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tLists the groups the specified user belongs to.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
Lists the groups the specified user belongs to.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "InstanceProfileName": { @@ -3930,7 +4127,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3938,7 +4135,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -3960,7 +4157,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -3978,7 +4175,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -3986,7 +4183,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -4073,7 +4270,7 @@ "documentation": "\n\t\tUse this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.
Path to the instance profile. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the instance profile. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "InstanceProfileName": { @@ -4110,7 +4307,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the instance profile. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -4118,7 +4315,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the instance profile. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -4140,7 +4337,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -4158,7 +4355,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -4166,7 +4363,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -4219,7 +4416,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -4332,7 +4529,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -4423,7 +4620,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -4488,7 +4685,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the role. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "RoleName": { @@ -4506,7 +4703,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the role. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -4514,7 +4711,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -4609,7 +4806,7 @@ "documentation": "\n\t\tContains the result of a successful invocation of the ListSAMLProviders action.
\n\t" }, "errors": [], - "documentation": "\n\t\tLists the SAML providers in the account.
\n\t\tLists the SAML providers in the account.
\n\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "ServerCertificateName": { @@ -4678,7 +4875,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -4686,13 +4883,18 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", - "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n\t" + "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n " + }, + "Expiration": { + "shape_name": "dateType", + "type": "timestamp", + "documentation": "\nThe date on which the certificate is set to expire.
\n " } }, "documentation": "\n\t\tServerCertificateMetadata contains information about a server certificate without its\n\t\t\tcertificate body, certificate chain, and private key.
\n\t\tThis data type is used as a response element in the action UploadServerCertificate and\n\t\t\t\tListServerCertificates.
\n\t" @@ -4717,7 +4919,7 @@ "documentation": "\n\t\tContains the result of a successful invocation of the ListServerCertificates\n\t\t\taction.
\n\t" }, "errors": [], - "documentation": "\n\t\tLists the server certificates that have the specified path prefix. If none exist, the action\n\t\t\treturns an empty list.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
Lists the server certificates that have the specified path prefix. If none exist, the action\n\t\t\treturns an empty list.
\n\t\tYou can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -4933,7 +5135,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -4998,7 +5200,7 @@ "min_length": 1, "max_length": 512, "pattern": "(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)", - "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -5016,7 +5218,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -5024,7 +5226,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -5098,7 +5300,7 @@ "documentation": "\n\t\tUse this parameter only when paginating results to indicate the maximum number of user names\n\t\t\tyou want in the response. If there are additional user names beyond the maximum you specify,\n\t\t\tthe IsTruncated response element is true. This parameter is\n\t\t\toptional. If you do not include it, it defaults to 100.
The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.
Path to the user. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the user. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UserName": { @@ -5160,7 +5362,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the user. For more information about IDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -5168,7 +5370,7 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the user. For more information about ARNs and how\n\t\t\tto use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "CreateDate": { @@ -5208,7 +5410,7 @@ "documentation": "\n\t\tContains the result of a successful invocation of the ListVirtualMFADevices\n\t\t\taction.
\n\t" }, "errors": [], - "documentation": "\n\t\t Lists the virtual MFA devices under the AWS account by assignment status. If you do not\n\t\t\tspecify an assignment status, the action returns a list of all virtual MFA devices. Assignment\n\t\t\tstatus can be Assigned, Unassigned, or Any.
You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
Lists the virtual MFA devices under the AWS account by assignment status. If you do not\n\t\t\tspecify an assignment status, the action returns a list of all virtual MFA devices. Assignment\n\t\t\tstatus can be Assigned, Unassigned, or Any.
You can paginate the results using the MaxItems and Marker\n\t\t\tparameters.
The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5275,7 +5477,7 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -5287,13 +5489,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tAdds (or updates) a policy document associated with the specified group. For information\n\t\t\tabout policies, refer to Overview of Policies in Using AWS Identity and Access Management.
\n\t\tFor information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tPutGroupPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.Adds (or updates) a policy document associated with the specified group. For information\n\t\t\tabout policies, refer to Overview of Policies in the Using IAM guide.
\n\t\tFor information about limits on the number of policies you can associate with a group, see Limitations on IAM Entities in the Using IAM guide.
\n\n\t\tPutGroupPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in the Using IAM guide.The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5352,7 +5554,7 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -5364,13 +5566,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tAdds (or updates) a policy document associated with the specified role. For information about\n\t\t\tpolicies, go to Overview of Policies in Using AWS Identity and Access Management.
\n\t\tFor information about limits on the policies you can associate with a role, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tPutRolePolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.Adds (or updates) a policy document associated with the specified role. For information about\n\t\t\tpolicies, go to Overview of Policies in the Using IAM guide.
\n\t\tFor information about limits on the policies you can associate with a role, see Limitations on IAM Entities in the Using IAM guide.
\n\n\t\tPutRolePolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in the Using IAM guide.The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5429,7 +5631,7 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -5441,13 +5643,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tAdds (or updates) a policy document associated with the specified user. For information about\n\t\t\tpolicies, refer to Overview of Policies in Using AWS Identity and Access Management.
\n\t\tFor information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tPutUserPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.Adds (or updates) a policy document associated with the specified user. For information about\n\t\t\tpolicies, refer to Overview of Policies in the Using IAM guide.
\n\t\tFor information about limits on the number of policies you can associate with a user, see Limitations on IAM Entities in the Using IAM guide.
\n\n\t\tPutUserPolicy. For information about setting up signatures and authorization\n\t\t\tthrough the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in the Using IAM guide.The request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5497,7 +5699,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5541,7 +5743,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5553,7 +5755,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5615,7 +5817,7 @@ "message": { "shape_name": "invalidAuthenticationCodeMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the authentication code was not recognized. The error\n\t\t\tmessage describes the specific error.
\n\t" @@ -5627,7 +5829,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5639,7 +5841,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -5692,7 +5894,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5704,13 +5906,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tChanges the status of the specified access key from Active to Inactive, or vice versa. This\n\t\t\taction can be used to disable a user's key as part of a key rotation work flow.
\n\t\tIf the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
For information about rotating keys, see Managing Keys and Certificates in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tChanges the status of the specified access key from Active to Inactive, or vice versa. This\n\t\t\taction can be used to disable a user's key as part of a key rotation work flow.
\n\t\tIf the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
For information about rotating keys, see Managing Keys and Certificates in the Using IAM\n\t\t\t\t guide.
\n\t\tThe minimum number of characters allowed in an IAM user password.
\n " }, "RequireSymbols": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\n Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters: ! @ # $ % ^ & * ( ) _ + - = [ ] { } | '\n " }, "RequireNumbers": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\nSpecifies whether IAM user passwords must contain at least one numeric character (0 to 9).
\n " }, "RequireUppercaseCharacters": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\nSpecifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).
\n " }, "RequireLowercaseCharacters": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\nSpecifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).
\n " }, "AllowUsersToChangePassword": { "shape_name": "booleanType", "type": "boolean", - "documentation": null + "documentation": "\nAllows 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 Using IAM guide.
\n " + }, + "MaxPasswordAge": { + "shape_name": "maxPasswordAgeType", + "type": "integer", + "min_length": 1, + "max_length": 1095, + "box": true, + "documentation": "\nThe number of days that an IAM user password is valid.
\n " + }, + "PasswordReusePrevention": { + "shape_name": "passwordReusePreventionType", + "type": "integer", + "min_length": 1, + "max_length": 24, + "box": true, + "documentation": "\nSpecifies the number of previous passwords that IAM users are prevented from reusing.
\n " + }, + "HardExpiry": { + "shape_name": "booleanObjectType", + "type": "boolean", + "box": true, + "documentation": "\nPrevents IAM users from setting a new password after their password has expired.
\n " } }, - "documentation": null + "documentation": " " }, "output": null, "errors": [ @@ -5762,7 +5986,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5774,7 +5998,7 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -5786,13 +6010,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tUpdates the password policy settings for the account. For more information about using a\n\t\t\tpassword policy, go to Managing an\n\t\t\t\tIAM Password Policy.
\n\t\tUpdates the password policy settings for the account. For more information about using a\n\t\t\tpassword policy, see Managing an\n\t\t\t\tIAM Password Policy in the Using IAM guide.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5842,7 +6066,7 @@ "message": { "shape_name": "malformedPolicyDocumentMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the policy document was malformed. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -5854,13 +6078,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tUpdates the policy that grants an entity permission to assume a role. Currently, only an\n\t\t\tAmazon EC2 instance can assume a role. For more information about roles, go to Working with\n\t\t\tRoles.
\n\t\tUpdates the policy that grants an entity permission to assume a role. For more information about roles, go to Working with\n\t\t\tRoles.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -5917,7 +6141,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -5929,13 +6153,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tUpdates the name and/or the path of the specified group.
\n\t\tUpdates the name and/or the path of the specified group.
\n\t\tThe new password for the user name.
\n\t", - "required": true + "documentation": "\n\t\tThe new password for the specified user.
\n\t" + }, + "PasswordResetRequired": { + "shape_name": "booleanObjectType", + "type": "boolean", + "box": true, + "documentation": "\nRequire the specified user to set a new password on next sign-in.
\n " } }, - "documentation": null + "documentation": " " }, "output": null, "errors": [ @@ -5974,7 +6203,7 @@ "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" @@ -5986,7 +6215,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -6010,7 +6239,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -6065,7 +6294,7 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -6089,13 +6318,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tUpdates the metadata document for an existing SAML provider.
\n\t\tUpdates the metadata document for an existing SAML provider.
\n\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -6152,7 +6381,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -6164,13 +6393,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tUpdates the name and/or the path of the specified server certificate.
\n\t\tUpdates the name and/or the path of the specified server certificate.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -6229,13 +6458,13 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" } ], - "documentation": "\n\t\tChanges the status of the specified signing certificate from active to disabled, or vice\n\t\t\tversa. This action can be used to disable a user's signing certificate as part of a\n\t\t\tcertificate rotation work flow.
\n\t\tIf the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
For information about rotating certificates, see Managing Keys and Certificates in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tChanges the status of the specified signing certificate from active to disabled, or vice\n\t\t\tversa. This action can be used to disable a user's signing certificate as part of a\n\t\t\tcertificate rotation work flow.
\n\t\tIf the UserName field is not specified, the UserName is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
For information about rotating certificates, see Managing Keys and Certificates in the Using IAM guide.
\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" @@ -6292,7 +6521,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -6304,7 +6533,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -6316,13 +6545,13 @@ "message": { "shape_name": "entityTemporarilyUnmodifiableMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that is temporarily unmodifiable,\n\t\t\tsuch as a user name that was deleted and then recreated. The error indicates that the request\n\t\t\tis likely to succeed if you try again after waiting several minutes. The error message\n\t\t\tdescribes the entity.
\n\t" } ], - "documentation": "\n\t\tUpdates the name and/or the path of the specified user.
\n\t\tUpdates the name and/or the path of the specified user.
\n\n\t\tThe path for the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\t" + "documentation": "\n\n\t\tThe path for the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\n\t\tThis parameter is optional. If it is not included, it defaults to a slash (/).
\n\n\t\t--path option. The path must begin\n\t\t\twith /cloudfront and must include a trailing slash (for example, /cloudfront/test/).\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tPath to the server certificate. For more information about paths, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "ServerCertificateName": { @@ -6409,7 +6638,7 @@ "min_length": 16, "max_length": 32, "pattern": "[\\w]*", - "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe stable and unique string identifying the server certificate. For more information about\n\t\t\tIDs, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "Arn": { @@ -6417,13 +6646,18 @@ "type": "string", "min_length": 20, "max_length": 2048, - "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t", + "documentation": "\n\t\tThe Amazon Resource Name (ARN) specifying the server certificate. For more information about\n\t\t\tARNs and how to use them in policies, see Identifiers for IAM Entities in the Using IAM guide.
\n\t", "required": true }, "UploadDate": { "shape_name": "dateType", "type": "timestamp", - "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n\t" + "documentation": "\n\t\tThe date when the server certificate was uploaded.
\n " + }, + "Expiration": { + "shape_name": "dateType", + "type": "timestamp", + "documentation": "\nThe date on which the certificate is set to expire.
\n " } }, "documentation": "\n\t\tThe meta information of the uploaded server certificate without its certificate body,\n\t\t\tcertificate chain, and private key.
\n\t" @@ -6439,7 +6673,7 @@ "message": { "shape_name": "limitExceededMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -6451,7 +6685,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -6463,7 +6697,7 @@ "message": { "shape_name": "malformedCertificateMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -6475,13 +6709,13 @@ "message": { "shape_name": "keyPairMismatchMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the public key certificate and the private key do not\n\t\t\tmatch.
\n\t" } ], - "documentation": "\n\t\tUploads a server certificate entity for the AWS account. The server certificate entity\n\t\t\tincludes a public key certificate, a private key, and an optional certificate chain, which\n\t\t\tshould all be PEM-encoded.
\n\t\tFor information about the number of server certificates you can upload, see Limitations on IAM Entities in Using AWS Identity and Access\n\t\t\t\tManagement.
\n\t\tUploadServerCertificate. For information about setting up signatures and\n\t\t\tauthorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.Uploads a server certificate entity for the AWS account. The server certificate entity\n\t\t\tincludes a public key certificate, a private key, and an optional certificate chain, which\n\t\t\tshould all be PEM-encoded.
\n\t\tFor information about the number of server certificates you can upload, see Limitations on IAM Entities in the Using IAM guide.
\n\n\n\t\tUploadServerCertificate. For information about setting up signatures and\n\t\t\tauthorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in the Using IAM guide.The request was rejected because it attempted to create resources beyond the current AWS\n\t\t\taccount limits. The error message describes the limit exceeded.
\n\t" @@ -6586,7 +6820,7 @@ "message": { "shape_name": "entityAlreadyExistsMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it attempted to create a resource that already exists.
\n\t" @@ -6598,7 +6832,7 @@ "message": { "shape_name": "malformedCertificateMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the certificate was malformed or expired. The error message\n\t\t\tdescribes the specific error.
\n\t" @@ -6610,7 +6844,7 @@ "message": { "shape_name": "invalidCertificateMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the certificate is invalid.
\n\t" @@ -6622,7 +6856,7 @@ "message": { "shape_name": "duplicateCertificateMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because the same certificate is associated to another user under the\n\t\t\taccount.
\n\t" @@ -6634,13 +6868,13 @@ "message": { "shape_name": "noSuchEntityMessage", "type": "string", - "documentation": " " + "documentation": null } }, "documentation": "\n\t\tThe request was rejected because it referenced an entity that does not exist. The error\n\t\t\tmessage describes the entity.
\n\t" } ], - "documentation": "\n\t\tUploads an X.509 signing certificate and associates it with the specified user. Some AWS\n\t\t\tservices use X.509 signing certificates to validate requests that are signed with a\n\t\t\tcorresponding private key. When you upload the certificate, its default status is\n\t\t\t\tActive.
If the UserName field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
UploadSigningCertificate. For information about setting up\n\t\t\tsignatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in Using IAM.Uploads an X.509 signing certificate and associates it with the specified user. Some AWS\n\t\t\tservices use X.509 signing certificates to validate requests that are signed with a\n\t\t\tcorresponding private key. When you upload the certificate, its default status is\n\t\t\t\tActive.
If the UserName field is not specified, the user name is determined implicitly\n\t\t\tbased on the AWS access key ID used to sign the request. Because this action works for access\n\t\t\tkeys under the AWS account, this API can be used to manage root credentials even if the AWS\n\t\t\taccount has no associated users.
UploadSigningCertificate. For information about setting up\n\t\t\tsignatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information\n\t\t\tabout using the Query API with IAM, go to Making\n\t\t\t\tQuery Requests in the Using IAMguide.This is the Amazon CloudWatch Logs API Reference. Amazon CloudWatch Logs is a managed service for real time monitoring\n and archival of application logs. This guide provides detailed\n information about Amazon CloudWatch Logs actions, data types, parameters, and\n errors. For detailed information about Amazon CloudWatch Logs features and their associated API calls,\n go to the Amazon CloudWatch Logs Developer Guide.\n
\n \nUse the following links to get started using the Amazon CloudWatch Logs API Reference:
\nIn addition to using the Amazon CloudWatch Logs API, you can also use the following SDKs and third-party libraries to\n access Amazon CloudWatch Logs programmatically.
\n \nDevelopers in the AWS developer community also provide their\town libraries, which you can find at the following AWS developer\n centers:
\nReturned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceAlreadyExistsException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource already exists.
\n " + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if you have reached the maximum number of resources that can be created.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Creates a new log group with the specified name. The name of the log group must be unique within a \n region for an AWS account. You can create up to 500 log groups per account.\n
\n\n You must use the following guidelines when naming a log group:\n
CreateLogGroup request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceAlreadyExistsException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource already exists.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Creates a new log stream in the specified log group. The name of the log stream must be unique within the log\n group. There is no limit on the number of log streams that can exist in a log group.\n
\n\n You must use the following guidelines when naming a log stream:\n
CreateLogStream request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Deletes the log group with the specified name and permanently deletes all the archived log events associated with it.\n
\nDeleteLogGroup request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Deletes a log stream and permanently deletes all the archived log events associated with it.\n
\nDeleteLogStream request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Deletes a metric filter associated with the specified log group.\n
\nDeleteMetricFilter request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy.\n
\nDeleteRetentionPolicy request and response.\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous DescribeLogGroups request.\n
\n The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.\n
\n " + } + }, + "documentation": null + }, + "output": { + "shape_name": "DescribeLogGroupsResponse", + "type": "structure", + "members": { + "logGroups": { + "shape_name": "LogGroups", + "type": "list", + "members": { + "shape_name": "LogGroup", + "type": "structure", + "members": { + "logGroupName": { + "shape_name": "LogGroupName", + "type": "string", + "min_length": 1, + "max_length": 512, + "pattern": "[\\.\\-_/#A-Za-z0-9]+", + "documentation": null + }, + "creationTime": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "retentionInDays": { + "shape_name": "Days", + "type": "integer", + "documentation": "\n 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, 547, 730.\n " + }, + "metricFilterCount": { + "shape_name": "FilterCount", + "type": "integer", + "documentation": "\n The number of metric filters associated with the log group.\n " + }, + "arn": { + "shape_name": "Arn", + "type": "string", + "documentation": null + }, + "storedBytes": { + "shape_name": "StoredBytes", + "type": "long", + "min_length": 0, + "documentation": null + } + }, + "documentation": null + }, + "documentation": "\n A list of log groups.\n " + }, + "nextToken": { + "shape_name": "NextToken", + "type": "string", + "documentation": "\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous request. The token expires after 24 hours.\n " + } + }, + "documentation": null + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Returns all the log groups that are associated with the AWS account making the request. The list returned in \n the response is ASCII-sorted by log group name.\n
\n\n By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a \n nextToken value in the response body. You can also limit the number of log groups returned in \n the response by specifying the limit parameter in the request.\n
DescribeLogGroups request and response.\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous DescribeLogStreams request.\n
\n The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.\n
\n " + } + }, + "documentation": null + }, + "output": { + "shape_name": "DescribeLogStreamsResponse", + "type": "structure", + "members": { + "logStreams": { + "shape_name": "LogStreams", + "type": "list", + "members": { + "shape_name": "LogStream", + "type": "structure", + "members": { + "logStreamName": { + "shape_name": "LogStreamName", + "type": "string", + "min_length": 1, + "max_length": 512, + "pattern": "[^:*]*", + "documentation": null + }, + "creationTime": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "firstEventTimestamp": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "lastEventTimestamp": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "lastIngestionTime": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "uploadSequenceToken": { + "shape_name": "SequenceToken", + "type": "string", + "min_length": 1, + "documentation": "\n A string token used for making PutLogEvents requests. AsequenceToken can only be used \n once, and PutLogEvents requests must include the sequenceToken obtained from the response\n of the previous request.\n "
+ },
+ "arn": {
+ "shape_name": "Arn",
+ "type": "string",
+ "documentation": null
+ },
+ "storedBytes": {
+ "shape_name": "StoredBytes",
+ "type": "long",
+ "min_length": 0,
+ "documentation": null
+ }
+ },
+ "documentation": "\n A log stream is sequence of log events that share the same emitter.\n "
+ },
+ "documentation": "\n A list of log streams.\n "
+ },
+ "nextToken": {
+ "shape_name": "NextToken",
+ "type": "string",
+ "documentation": "\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous request. The token expires after 24 hours.\n "
+ }
+ },
+ "documentation": null
+ },
+ "errors": [
+ {
+ "shape_name": "InvalidParameterException",
+ "type": "structure",
+ "members": {},
+ "documentation": "\n Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Returns all the log streams that are associated with the specified log group. The list returned in \n the response is ASCII-sorted by log stream name.\n
\n\n By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a \n nextToken value in the response body. You can also limit the number of log streams returned in \n the response by specifying the limit parameter in the request.\n
DescribeLogStreams request and response.\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous DescribeMetricFilters request.\n
\n The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items.\n
\n " + } + }, + "documentation": null + }, + "output": { + "shape_name": "DescribeMetricFiltersResponse", + "type": "structure", + "members": { + "metricFilters": { + "shape_name": "MetricFilters", + "type": "list", + "members": { + "shape_name": "MetricFilter", + "type": "structure", + "members": { + "filterName": { + "shape_name": "FilterName", + "type": "string", + "min_length": 1, + "max_length": 512, + "pattern": "[^:*]*", + "documentation": "\n The name of the metric filter.\n " + }, + "filterPattern": { + "shape_name": "FilterPattern", + "type": "string", + "min_length": 0, + "max_length": 512, + "documentation": null + }, + "metricTransformations": { + "shape_name": "MetricTransformations", + "type": "list", + "members": { + "shape_name": "MetricTransformation", + "type": "structure", + "members": { + "metricName": { + "shape_name": "MetricName", + "type": "string", + "max_length": 255, + "pattern": "[^:*$]*", + "documentation": null, + "required": true + }, + "metricNamespace": { + "shape_name": "MetricNamespace", + "type": "string", + "max_length": 255, + "pattern": "[^:*$]*", + "documentation": null, + "required": true + }, + "metricValue": { + "shape_name": "MetricValue", + "type": "string", + "max_length": 100, + "documentation": null, + "required": true + } + }, + "documentation": null + }, + "min_length": 1, + "max_length": 1, + "documentation": null + }, + "creationTime": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + } + }, + "documentation": "\n Metric filters can be used to express how Amazon CloudWatch Logs would extract metric observations from ingested log events and \n transform them to metric data in a CloudWatch metric.\n " + }, + "documentation": null + }, + "nextToken": { + "shape_name": "NextToken", + "type": "string", + "documentation": "\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous request. The token expires after 24 hours.\n " + } + }, + "documentation": null + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Returns all the metrics filters associated with the specified log group. The list returned in \n the response is ASCII-sorted by filter name.\n
\n\n By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a \n nextToken value in the response body. You can also limit the number of metric filters returned in \n the response by specifying the limit parameter in the request.\n
DescribeMetricFilters request and response.\n A string token used for pagination that points to the next page of results. It must be a value obtained from the \n nextForwardToken or nextBackwardToken fields in the\n response of the previous GetLogEvents request.\n
\n The maximum number of log events returned in the response. If you don't specify a value, the request would return as much log events\n as can fit in a response size of 1MB, up to 10,000 log events.\n
\n " + }, + "startFromHead": { + "shape_name": "StartFromHead", + "type": "boolean", + "documentation": null + } + }, + "documentation": null + }, + "output": { + "shape_name": "GetLogEventsResponse", + "type": "structure", + "members": { + "events": { + "shape_name": "OutputLogEvents", + "type": "list", + "members": { + "shape_name": "OutputLogEvent", + "type": "structure", + "members": { + "timestamp": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + }, + "message": { + "shape_name": "EventMessage", + "type": "string", + "min_length": 1, + "max_length": 32768, + "documentation": null + }, + "ingestionTime": { + "shape_name": "Timestamp", + "type": "long", + "min_length": 0, + "documentation": "\n A point in time expressed as the number milliseconds since Jan 1, 1970 00:00:00 UTC.\n " + } + }, + "documentation": null + }, + "documentation": null + }, + "nextForwardToken": { + "shape_name": "NextToken", + "type": "string", + "documentation": "\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous request. The token expires after 24 hours.\n " + }, + "nextBackwardToken": { + "shape_name": "NextToken", + "type": "string", + "documentation": "\n A string token used for pagination that points to the next page of results. It must be a value obtained from the\n response of the previous request. The token expires after 24 hours.\n " + } + }, + "documentation": null + }, + "errors": [ + { + "shape_name": "InvalidParameterException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event\n timestamp.\n
\n 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 \n will always include a nextForwardToken and a nextBackwardToken in the response body. You can use\n any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction.\n You can also limit the number of log events returned in the response by specifying the limit parameter in the request.\n
GetLogEvents request and response.\n A string token that must be obtained from the response of the previous PutLogEvents request.\n
sequenceToken can only be used \n once, and PutLogEvents requests must include the sequenceToken obtained from the response\n of the previous request.\n "
+ }
+ },
+ "documentation": null
+ },
+ "errors": [
+ {
+ "shape_name": "InvalidParameterException",
+ "type": "structure",
+ "members": {},
+ "documentation": "\n Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "InvalidSequenceTokenException", + "type": "structure", + "members": { + "expectedSequenceToken": { + "shape_name": "SequenceToken", + "type": "string", + "min_length": 1, + "documentation": "\n A string token used for making PutLogEvents requests. AsequenceToken can only be used \n once, and PutLogEvents requests must include the sequenceToken obtained from the response\n of the previous request.\n "
+ }
+ },
+ "documentation": null
+ },
+ {
+ "shape_name": "DataAlreadyAcceptedException",
+ "type": "structure",
+ "members": {
+ "expectedSequenceToken": {
+ "shape_name": "SequenceToken",
+ "type": "string",
+ "min_length": 1,
+ "documentation": "\n A string token used for making PutLogEvents requests. A sequenceToken can only be used \n once, and PutLogEvents requests must include the sequenceToken obtained from the response\n of the previous request.\n "
+ }
+ },
+ "documentation": null
+ },
+ {
+ "shape_name": "ResourceNotFoundException",
+ "type": "structure",
+ "members": {},
+ "documentation": "\n Returned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Uploads a batch of log events to the specified log stream.\n
\n\n Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request.\n An upload in a newly created log stream does not require a sequenceToken.\n
\n The batch of events must satisfy the following constraints:\n
timestamp.PutLogEvents request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "LimitExceededException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if you have reached the maximum number of resources that can be created.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules \n to extract metric data from log events ingested through PutLogEvents requests.\n
PutMetricFilter request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ResourceNotFoundException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the specified resource does not exist.
\n " + }, + { + "shape_name": "OperationAbortedException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if multiple requests to update the same resource were in conflict.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Sets the retention of the specified log group. A retention policy allows you to configure the\n number of days you want to retain log events in the specified log group.\n
\nPutRetentionPolicy request and response.Returned if a parameter of the request is incorrectly specified.
\n " + }, + { + "shape_name": "ServiceUnavailableException", + "type": "structure", + "members": {}, + "documentation": "\nReturned if the service cannot complete the request.
\n " + } + ], + "documentation": "\n\n Tests the filter pattern of a metric filter against a sample of log event messages. You can use this\n operation to validate the correctness of a metric filter pattern.\n
\nTestMetricFilter request and response.TestMetricFilter request and response.TestMetricFilter request and response.TestMetricFilter request and response.TestMetricFilter request and response.TestMetricFilter request and response.TestMetricFilter request and response.Weighted, Regional, 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.
\n " + "documentation": "\nWeighted, 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.
\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", @@ -114,7 +114,40 @@ "sa-east-1", "cn-north-1" ], - "documentation": "\nRegional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
\n " + "documentation": "\nLatency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
\n " + }, + "GeoLocation": { + "shape_name": "GeoLocation", + "type": "structure", + "members": { + "ContinentCode": { + "shape_name": "GeoLocationContinentCode", + "type": "string", + "min_length": 2, + "max_length": 2, + "documentation": "\nThe code for a continent geo location. Note: only continent locations have a continent code.
\nValid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
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.
\nThe 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's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
\nConstraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", @@ -201,6 +234,7 @@ "SetIdentifier", "Weight", "Region", + "GeoLocation", "Failover", "TTL", "ResourceRecords", @@ -360,6 +394,142 @@ ], "documentation": "\nUse this action to create or change your authoritative DNS information. To use this action, send a POST request to the 2013-04-01/hostedzone/hosted Zone ID/rrset resource. The request body must include an XML 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 Creating, Changing, and Deleting Resource Record Sets Using the Route 53 API in the Amazon Route 53 Developer Guide.
\nInvalidChangeBatch error.In response to a ChangeResourceRecordSets request, your DNS data is changed on all Route 53 DNS servers. Initially, the status of a change is PENDING. This means the change has not yet propagated to all the authoritative 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:
- A request cannot contain more than 100 Change elements.
\n- A request cannot contain more than 1000 ResourceRecord elements.
\nThe sum of the number of characters (including spaces) in all Value elements in a request cannot exceed 32,000 characters.
The type of the resource. The resource type for health checks is healthcheck.
The ID of the resource for which you want to add, change, or delete tags.
\n ", + "required": true, + "location": "uri" + }, + "AddTags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "max_length": 128, + "documentation": "\nThe key for a Tag.
The value for a Tag.
A single tag containing a key and value.
\n ", + "xmlname": "Tag" + }, + "min_length": 1, + "max_length": 10, + "documentation": "\nA 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.
A list of Tag keys that you want to remove from the specified resource.
A complex type containing information about a request to add, change, or delete the tags that are associated with a resource.
\n " + }, + "output": { + "shape_name": "ChangeTagsForResourceResponse", + "type": "structure", + "members": {}, + "documentation": "\nEmpty response for the request.
\n " + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + }, + { + "shape_name": "NoSuchHealthCheck", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " + }, + { + "shape_name": "PriorRequestNotComplete", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request was rejected because Route 53 was still processing a prior request.
\n " + }, + { + "shape_name": "ThrottlingException", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": null + } + ], + "documentation": null + }, "CreateHealthCheck": { "name": "CreateHealthCheck", "http": { @@ -562,12 +732,20 @@ ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true + }, + "HealthCheckVersion": { + "shape_name": "HealthCheckVersion", + "type": "long", + "min_length": 1, + "documentation": "\nThe version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to\n prevent overwriting another change to the health check.
A complex type that contains identifying information about the health check.
\n ", "required": true @@ -1194,6 +1372,177 @@ ], "documentation": "\nThis action returns the current status of a change batch request. The status is one of the following values:
\n- PENDING indicates that the changes in this request have not replicated to all 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.
Empty request.
\n " + }, + "output": { + "shape_name": "GetCheckerIpRangesResponse", + "type": "structure", + "members": { + "CheckerIpRanges": { + "shape_name": "CheckerIpRanges", + "type": "list", + "members": { + "shape_name": "IPAddressCidr", + "type": "string", + "documentation": null + }, + "documentation": "\nA complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.
\n ", + "required": true + } + }, + "documentation": "\nA complex type that contains the CheckerIpRanges element.
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 2013-04-01/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.
The code for a continent geo location. Note: only continent locations have a continent code.
\nValid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
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.
\nThe 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's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
\nConstraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
A complex type that contains information about the request to get a geo location.
\n " + }, + "output": { + "shape_name": "GetGeoLocationResponse", + "type": "structure", + "members": { + "GeoLocationDetails": { + "shape_name": "GeoLocationDetails", + "type": "structure", + "members": { + "ContinentCode": { + "shape_name": "GeoLocationContinentCode", + "type": "string", + "min_length": 2, + "max_length": 2, + "documentation": "\nThe code for a continent geo location. Note: only continent locations have a continent code.
\n " + }, + "ContinentName": { + "shape_name": "GeoLocationContinentName", + "type": "string", + "min_length": 1, + "max_length": 32, + "documentation": "\nThe 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.
\nThe default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The name of the country. This element is only present if CountryCode is also present.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
\n " + }, + "SubdivisionName": { + "shape_name": "GeoLocationSubdivisionName", + "type": "string", + "min_length": 1, + "max_length": 64, + "documentation": "\nThe name of the subdivision. This element is only present if SubdivisionCode is also present.
A complex type that contains the information about the specified geo location.
\n ", + "required": true + } + }, + "member_order": [ + "GeoLocationDetails" + ], + "documentation": "\nA complex type containing information about the specified geo location.
\n " + }, + "errors": [ + { + "shape_name": "NoSuchGeoLocation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nThe geo location you are trying to get does not exist.
\n " + }, + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + } + ], + "documentation": null + }, "GetHealthCheck": { "name": "GetHealthCheck", "http": { @@ -1317,12 +1666,20 @@ ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true + }, + "HealthCheckVersion": { + "shape_name": "HealthCheckVersion", + "type": "long", + "min_length": 1, + "documentation": "\nThe version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to\n prevent overwriting another change to the health check.
A complex type that contains the information about the specified health check.
\n ", "required": true @@ -1373,6 +1730,34 @@ ], "documentation": "\n To retrieve the health check, send a GET request to the 2013-04-01/healthcheck/health check ID resource.
To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
The number of health checks associated with the current AWS account.
\n ", + "required": true + } + }, + "documentation": "\nA complex type that contains the count of health checks associated with the current AWS account.
\n " + }, + "errors": [], + "documentation": "\n To retrieve a count of all your health checks, send a GET request to the 2013-04-01/healthcheckcount resource.
To retrieve the delegation set for a hosted zone, send a GET request to the 2013-04-01/hostedzone/hosted zone ID resource. The delegation set is the four Route 53 name servers that were assigned to the hosted zone when you created it.
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.
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.
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.
The maximum number of geo locations you want in the response body.
\n ", + "location": "uri" + } + }, + "member_order": [ + "StartContinentCode", + "StartCountryCode", + "StartSubdivisionCode", + "MaxItems" + ], + "documentation": "\nThe input for a ListGeoLocations request.
\n " + }, + "output": { + "shape_name": "ListGeoLocationsResponse", + "type": "structure", + "members": { + "GeoLocationDetailsList": { + "shape_name": "GeoLocationDetailsList", + "type": "list", + "members": { + "shape_name": "GeoLocationDetails", + "type": "structure", + "members": { + "ContinentCode": { + "shape_name": "GeoLocationContinentCode", + "type": "string", + "min_length": 2, + "max_length": 2, + "documentation": "\nThe code for a continent geo location. Note: only continent locations have a continent code.
\n " + }, + "ContinentName": { + "shape_name": "GeoLocationContinentName", + "type": "string", + "min_length": 1, + "max_length": 32, + "documentation": "\nThe 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.
\nThe default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.
The name of the country. This element is only present if CountryCode is also present.
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
\n " + }, + "SubdivisionName": { + "shape_name": "GeoLocationSubdivisionName", + "type": "string", + "min_length": 1, + "max_length": 64, + "documentation": "\nThe name of the subdivision. This element is only present if SubdivisionCode is also present.
A complex type that contains information about a GeoLocation.
A complex type that contains information about the geo locations that are returned by the request.
\n ", + "required": true + }, + "IsTruncated": { + "shape_name": "PageTruncated", + "type": "boolean", + "documentation": "\nA 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 ListGeoLocationsResponse$NextContinentCode, ListGeoLocationsResponse$NextCountryCode and ListGeoLocationsResponse$NextSubdivisionCode elements.
\nValid Values: true | false
If the results were truncated, the continent code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is a continent location.
\n " + }, + "NextCountryCode": { + "shape_name": "GeoLocationCountryCode", + "type": "string", + "min_length": 1, + "max_length": 2, + "documentation": "\nIf the results were truncated, the country code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location to list is not a continent location.
\n " + }, + "NextSubdivisionCode": { + "shape_name": "GeoLocationSubdivisionCode", + "type": "string", + "min_length": 1, + "max_length": 3, + "documentation": "\nIf the results were truncated, the subdivision code of the next geo location in the list. This element is present only if ListGeoLocationsResponse$IsTruncated is true and the next geo location has a subdivision.
\n " + }, + "MaxItems": { + "shape_name": "PageMaxItems", + "type": "string", + "documentation": "\nThe maximum number of records you requested. The maximum value of MaxItems is 100.
A complex type that contains information about the geo locations that are returned by the request and information about the response.
\n " + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + } + ], + "documentation": null + }, "ListHealthChecks": { "name": "ListHealthChecks", "http": { @@ -1651,12 +2213,20 @@ ], "documentation": "\nA complex type that contains the health check configuration.
\n ", "required": true + }, + "HealthCheckVersion": { + "shape_name": "HealthCheckVersion", + "type": "long", + "min_length": 1, + "documentation": "\nThe version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to\n prevent overwriting another change to the health check.
A complex type that contains identifying information about the health check.
\n ", "xmlname": "HealthCheck" @@ -2000,7 +2570,7 @@ "type": "string", "min_length": 1, "max_length": 128, - "documentation": "\nWeighted, Regional, 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.
\n " + "documentation": "\nWeighted, 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.
\n " }, "Weight": { "shape_name": "ResourceRecordSetWeight", @@ -2025,7 +2595,40 @@ "sa-east-1", "cn-north-1" ], - "documentation": "\nRegional resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
\n " + "documentation": "\nLatency-based resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
\n " + }, + "GeoLocation": { + "shape_name": "GeoLocation", + "type": "structure", + "members": { + "ContinentCode": { + "shape_name": "GeoLocationContinentCode", + "type": "string", + "min_length": 2, + "max_length": 2, + "documentation": "\nThe code for a continent geo location. Note: only continent locations have a continent code.
\nValid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
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.
\nThe 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's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
\nConstraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.
Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
\n " }, "Failover": { "shape_name": "ResourceRecordSetFailover", @@ -2112,6 +2715,7 @@ "SetIdentifier", "Weight", "Region", + "GeoLocation", "Failover", "TTL", "ResourceRecords", @@ -2224,6 +2828,550 @@ "start_record_identifier" ] } + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "uri": "/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input": { + "shape_name": "ListTagsForResourceRequest", + "type": "structure", + "members": { + "ResourceType": { + "shape_name": "TagResourceType", + "type": "string", + "enum": [ + "healthcheck" + ], + "documentation": "\nThe type of the resource. The resource type for health checks is healthcheck.
The ID of the resource for which you want to retrieve tags.
\n ", + "required": true, + "location": "uri" + } + }, + "member_order": [ + "ResourceType", + "ResourceId" + ], + "documentation": "\nA complex type containing information about a request for a list of the tags that are associated with an individual resource.
\n " + }, + "output": { + "shape_name": "ListTagsForResourceResponse", + "type": "structure", + "members": { + "ResourceTagSet": { + "shape_name": "ResourceTagSet", + "type": "structure", + "members": { + "ResourceType": { + "shape_name": "TagResourceType", + "type": "string", + "enum": [ + "healthcheck" + ], + "documentation": "\nThe type of the resource. The resource type for health checks is healthcheck.
The ID for the specified resource.
\n " + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "max_length": 128, + "documentation": "\nThe key for a Tag.
The value for a Tag.
A single tag containing a key and value.
\n ", + "xmlname": "Tag" + }, + "min_length": 1, + "max_length": 10, + "documentation": "\nThe tags associated with the specified resource.
\n " + } + }, + "documentation": "\nA ResourceTagSet containing tags associated with the specified resource.
A complex type containing tags for the specified resource.
\n " + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + }, + { + "shape_name": "NoSuchHealthCheck", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " + }, + { + "shape_name": "PriorRequestNotComplete", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request was rejected because Route 53 was still processing a prior request.
\n " + }, + { + "shape_name": "ThrottlingException", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": null + } + ], + "documentation": null + }, + "ListTagsForResources": { + "name": "ListTagsForResources", + "http": { + "method": "POST", + "uri": "/2013-04-01/tags/{ResourceType}" + }, + "input": { + "shape_name": "ListTagsForResourcesRequest", + "type": "structure", + "members": { + "ResourceType": { + "shape_name": "TagResourceType", + "type": "string", + "enum": [ + "healthcheck" + ], + "documentation": "\nThe type of the resources. The resource type for health checks is healthcheck.
A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.
\n ", + "required": true + } + }, + "member_order": [ + "ResourceType", + "ResourceIds" + ], + "documentation": "\nA complex type containing information about a request for a list of the tags that are associated with up to 10 specified resources.
\n " + }, + "output": { + "shape_name": "ListTagsForResourcesResponse", + "type": "structure", + "members": { + "ResourceTagSets": { + "shape_name": "ResourceTagSetList", + "type": "list", + "members": { + "shape_name": "ResourceTagSet", + "type": "structure", + "members": { + "ResourceType": { + "shape_name": "TagResourceType", + "type": "string", + "enum": [ + "healthcheck" + ], + "documentation": "\nThe type of the resource. The resource type for health checks is healthcheck.
The ID for the specified resource.
\n " + }, + "Tags": { + "shape_name": "TagList", + "type": "list", + "members": { + "shape_name": "Tag", + "type": "structure", + "members": { + "Key": { + "shape_name": "TagKey", + "type": "string", + "max_length": 128, + "documentation": "\nThe key for a Tag.
The value for a Tag.
A single tag containing a key and value.
\n ", + "xmlname": "Tag" + }, + "min_length": 1, + "max_length": 10, + "documentation": "\nThe tags associated with the specified resource.
\n " + } + }, + "documentation": "\nA complex type containing a resource and its associated tags.
\n ", + "xmlname": "ResourceTagSet" + }, + "documentation": "\nA list of ResourceTagSets containing tags associated with the specified resources.
A complex type containing tags for the specified resources.
\n " + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + }, + { + "shape_name": "NoSuchHealthCheck", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " + }, + { + "shape_name": "PriorRequestNotComplete", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request was rejected because Route 53 was still processing a prior request.
\n " + }, + { + "shape_name": "ThrottlingException", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": null + } + ], + "documentation": null + }, + "UpdateHealthCheck": { + "name": "UpdateHealthCheck", + "http": { + "method": "POST", + "uri": "/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input": { + "shape_name": "UpdateHealthCheckRequest", + "type": "structure", + "members": { + "HealthCheckId": { + "shape_name": "HealthCheckId", + "type": "string", + "max_length": 64, + "documentation": "\nThe ID of the health check to update.
\n ", + "required": true, + "location": "uri" + }, + "HealthCheckVersion": { + "shape_name": "HealthCheckVersion", + "type": "long", + "min_length": 1, + "documentation": "\nOptional. When you specify a health check version, Route 53 compares this value with the current value in the health check,\n which prevents you from updating the health check when the versions don't match. Using HealthCheckVersion lets you\n prevent overwriting another change to the health check.
The IP address of the resource that you want to check.
\nSpecify this value only if you want to change it.
\n " + }, + "Port": { + "shape_name": "Port", + "type": "integer", + "min_length": 1, + "max_length": 65535, + "documentation": "\nThe port on which you want Route 53 to open a connection to perform health checks.
\nSpecify this value only if you want to change it.
\n " + }, + "ResourcePath": { + "shape_name": "ResourcePath", + "type": "string", + "max_length": 255, + "documentation": "\nThe path that you want Amazon Route 53 to request when performing health checks. The path can be any value for\n which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the\n file /docs/route53-health-check.html.
\nSpecify this value only if you want to change it.
\n " + }, + "FullyQualifiedDomainName": { + "shape_name": "FullyQualifiedDomainName", + "type": "string", + "max_length": 255, + "documentation": "\nFully qualified domain name of the instance to be health checked.
\nSpecify this value only if you want to change it.
\n " + }, + "SearchString": { + "shape_name": "SearchString", + "type": "string", + "max_length": 255, + "documentation": "\nIf the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string\n that you want Route 53 to search for in the response body from the specified resource. If the string appears\n in the response body, Route 53 considers the resource healthy.
Specify this value only if you want to change it.
\n " + }, + "FailureThreshold": { + "shape_name": "FailureThreshold", + "type": "integer", + "min_length": 1, + "max_length": 10, + "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\nSpecify this value only if you want to change it.
\n " + } + }, + "member_order": [ + "HealthCheckId", + "HealthCheckVersion", + "IPAddress", + "Port", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "FailureThreshold" + ], + "documentation": "\n>A complex type that contains information about the request to update a health check.
\n " + }, + "output": { + "shape_name": "UpdateHealthCheckResponse", + "type": "structure", + "members": { + "HealthCheck": { + "shape_name": "HealthCheck", + "type": "structure", + "members": { + "Id": { + "shape_name": "HealthCheckId", + "type": "string", + "max_length": 64, + "documentation": "\nThe ID of the specified health check.
\n ", + "required": true + }, + "CallerReference": { + "shape_name": "HealthCheckNonce", + "type": "string", + "min_length": 1, + "max_length": 64, + "documentation": "\nA unique string that identifies the request to create the health check.
\n ", + "required": true + }, + "HealthCheckConfig": { + "shape_name": "HealthCheckConfig", + "type": "structure", + "members": { + "IPAddress": { + "shape_name": "IPAddress", + "type": "string", + "max_length": 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])$", + "documentation": "\nIP Address of the instance being checked.
\n " + }, + "Port": { + "shape_name": "Port", + "type": "integer", + "min_length": 1, + "max_length": 65535, + "documentation": "\nPort 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.
\n " + }, + "Type": { + "shape_name": "HealthCheckType", + "type": "string", + "enum": [ + "HTTP", + "HTTPS", + "HTTP_STR_MATCH", + "HTTPS_STR_MATCH", + "TCP" + ], + "documentation": "\nThe type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
\n ", + "required": true + }, + "ResourcePath": { + "shape_name": "ResourcePath", + "type": "string", + "max_length": 255, + "documentation": "\nPath to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued to the instance on the given port and path.
\n " + }, + "FullyQualifiedDomainName": { + "shape_name": "FullyQualifiedDomainName", + "type": "string", + "max_length": 255, + "documentation": "\nFully qualified domain name of the instance to be health checked.
\n " + }, + "SearchString": { + "shape_name": "SearchString", + "type": "string", + "max_length": 255, + "documentation": "\nA string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks.
\n " + }, + "RequestInterval": { + "shape_name": "RequestInterval", + "type": "integer", + "min_length": 10, + "max_length": 30, + "documentation": "\nThe number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
\nEach Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
\n " + }, + "FailureThreshold": { + "shape_name": "FailureThreshold", + "type": "integer", + "min_length": 1, + "max_length": 10, + "documentation": "\nThe number of consecutive health checks that an endpoint must pass or fail for Route 53 to\n change the current status of the endpoint from unhealthy to healthy or vice versa.
\nValid values are integers between 1 and 10. For more information,\n see \"How Amazon Route 53 Determines Whether an Endpoint Is Healthy\" in the\n Amazon Route 53 Developer Guide.
\n " + } + }, + "member_order": [ + "IPAddress", + "Port", + "Type", + "ResourcePath", + "FullyQualifiedDomainName", + "SearchString", + "RequestInterval", + "FailureThreshold" + ], + "documentation": "\nA complex type that contains the health check configuration.
\n ", + "required": true + }, + "HealthCheckVersion": { + "shape_name": "HealthCheckVersion", + "type": "long", + "min_length": 1, + "documentation": "\nThe version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to\n prevent overwriting another change to the health check.
A complex type that contains identifying information about the health check.
\n ", + "required": true + } + }, + "member_order": [ + "HealthCheck" + ], + "documentation": null + }, + "errors": [ + { + "shape_name": "NoSuchHealthCheck", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nThe health check you are trying to get or delete does not exist.
\n " + }, + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDescriptive message for the error response.
\n " + } + }, + "documentation": "\nSome value specified in the request is invalid or the XML document is malformed.
\n " + }, + { + "shape_name": "HealthCheckVersionMismatch", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": null + } + ], + "documentation": "\nThis action updates an existing health check.
\n To update a health check, send a POST request to the 2013-05-27/healthcheck/health check ID resource. The request body must include an XML document with an UpdateHealthCheckRequest element. The response returns an UpdateHealthCheckResponse element, which contains metadata about the health check.
The name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "IdnLangCode": { + "shape_name": "LangCode", + "type": "string", + "max_length": 3, + "documentation": "\nReserved for future use.
\n" + } + }, + "documentation": "\nThe CheckDomainAvailability request contains the following elements.
\n" + }, + "output": { + "shape_name": "CheckDomainAvailabilityResponse", + "type": "structure", + "members": { + "Availability": { + "shape_name": "DomainAvailability", + "type": "string", + "enum": [ + "AVAILABLE", + "AVAILABLE_RESERVED", + "AVAILABLE_PREORDER", + "UNAVAILABLE", + "UNAVAILABLE_PREMIUM", + "UNAVAILABLE_RESTRICTED", + "RESERVED" + ], + "documentation": "\nWhether the domain name is available for registering.
\nYou can only register domains designated as AVAILABLE.
Type: String
\nValid values:
\nAVAILABLE \u2013 The domain name is available.AVAILABLE_RESERVED \u2013 The domain name is reserved under specific conditions.AVAILABLE_PREORDER \u2013 The domain name is available and can be preordered.UNAVAILABLE \u2013 The domain name is not available.UNAVAILABLE_PREMIUM \u2013 The domain name is not available.UNAVAILABLE_RESTRICTED \u2013 The domain name is forbidden.RESERVED \u2013 The domain name has been reserved for another person or organization.The CheckDomainAvailability response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "UnsupportedTLD", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nAmazon Route 53 does not support this top-level domain.
\n" + } + ], + "documentation": "\nThis operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + } + }, + "documentation": "\nThe DisableDomainTransferLock request includes the following element.
\n" + }, + "output": { + "shape_name": "DisableDomainTransferLockResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe DisableDomainTransferLock response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation removes the transfer lock on the domain (specifically the\nclientTransferProhibited status) to allow domain transfers. We recommend\nyou refrain from performing this action unless you intend to transfer the domain to a\ndifferent registrar. Successful submission returns an operation ID that you can use to track\nthe progress and completion of the action. If the request is not completed successfully, the\ndomain registrant will be notified by email.
The name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + } + }, + "documentation": "\nThe EnableDomainTransferLock request includes the following element.
\n" + }, + "output": { + "shape_name": "EnableDomainTransferLockResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe EnableDomainTransferLock response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation sets the transfer lock on the domain (specifically the\nclientTransferProhibited status) to prevent domain transfers. Successful submission\nreturns an operation ID that you can use to track the progress and completion of the action. If the\nrequest is not completed successfully, the domain registrant will be notified by email.
The name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + } + }, + "documentation": "\nThe GetDomainDetail request includes the following element.
\n" + }, + "output": { + "shape_name": "GetDomainDetailResponse", + "type": "structure", + "members": { + "DomainName": { + "shape_name": "DomainName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe name of a domain.
\nType: String
\n", + "required": true + }, + "Nameservers": { + "shape_name": "NameserverList", + "type": "list", + "members": { + "shape_name": "Nameserver", + "type": "structure", + "members": { + "Name": { + "shape_name": "HostName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe fully qualified host name of the name server.
\nType: String
\nConstraint: Maximum 255 characterss
\nParent: Nameservers
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
\nType: List of IP addresses.
\nConstraints: The list can contain only one IPv4 and one IPv6 address.
\nParent: Nameservers
Nameserver includes the following elements.
\n" + }, + "documentation": "\nThe name of the domain.
\nType: String
\n", + "required": true + }, + "AutoRenew": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether the domain registration is set to renew automatically.
\nType: Boolean
\n" + }, + "AdminContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides details about the domain administrative contact.
\nType: Complex
\nChildren: FirstName, MiddleName,\nLastName, ContactType,\nOrganizationName, AddressLine1,\nAddressLine2, City, State,\nCountryCode, ZipCode,\nPhoneNumber, Email, Fax,\nExtraParams
First name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides details about the domain registrant.
\nType: Complex
\nChildren: FirstName, MiddleName,\nLastName, ContactType,\nOrganizationName, AddressLine1,\nAddressLine2, City, State,\nCountryCode, ZipCode,\nPhoneNumber, Email, Fax,\nExtraParams
First name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides details about the domain technical contact.
\nType: Complex
\nChildren: FirstName, MiddleName,\nLastName, ContactType,\nOrganizationName, AddressLine1,\nAddressLine2, City, State,\nCountryCode, ZipCode,\nPhoneNumber, Email, Fax,\nExtraParams
Specifies whether contact information for the admin contact is concealed from WHOIS queries.\nIf the value is true, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
\n" + }, + "RegistrantPrivacy": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether contact information for the registrant contact is concealed from WHOIS queries.\nIf the value is true, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
\n" + }, + "TechPrivacy": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nSpecifies whether contact information for the tech contact is concealed from WHOIS queries.\nIf the value is true, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.
Type: Boolean
\n" + }, + "RegistrarName": { + "shape_name": "RegistrarName", + "type": "string", + "documentation": "\nName of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi.\nThe value is \"GANDI SAS\".
Type: String
\n" + }, + "WhoIsServer": { + "shape_name": "RegistrarWhoIsServer", + "type": "string", + "documentation": "\nThe fully qualified name of the WHOIS server that can answer the WHOIS query for the\ndomain.
\nType: String
\n" + }, + "RegistrarUrl": { + "shape_name": "RegistrarUrl", + "type": "string", + "documentation": "\nWeb address of the registrar.
\nType: String
\n" + }, + "AbuseContactEmail": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address to contact to report incorrect contact information for a domain, to report that the domain\nis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type\nof abuse.
\nType: String
\n" + }, + "AbuseContactPhone": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nPhone number for reporting abuse.
\nType: String
\n" + }, + "RegistryDomainId": { + "shape_name": "RegistryDomainId", + "type": "string", + "documentation": "\nReserved for future use.
\n" + }, + "CreationDate": { + "shape_name": "Timestamp", + "type": "timestamp", + "documentation": "\nThe date when the domain was created as found in the response to a WHOIS query. The date\nformat is Unix time.
\n" + }, + "UpdatedDate": { + "shape_name": "Timestamp", + "type": "timestamp", + "documentation": "\nThe last updated date of the domain as found in the response to a WHOIS query. The date\nformat is Unix time.
\n" + }, + "ExpirationDate": { + "shape_name": "Timestamp", + "type": "timestamp", + "documentation": "\nThe date when the registration for the domain is set to expire. The date format is Unix time.
\n" + }, + "Reseller": { + "shape_name": "Reseller", + "type": "string", + "documentation": "\nReseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have\n\"Amazon\" as the reseller.
Type: String
\n" + }, + "DnsSec": { + "shape_name": "DNSSec", + "type": "string", + "documentation": "\nReserved for future use.
\n" + }, + "StatusList": { + "shape_name": "DomainStatusList", + "type": "list", + "members": { + "shape_name": "DomainStatus", + "type": "string", + "documentation": null + }, + "documentation": "\nAn array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.
\nICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes\nthat tell you the status of a variety of operations on a domain name, for example, registering a domain name,\ntransferring a domain name to another registrar, renewing the registration for a domain name, and so on.\nAll registrars use this same set of status codes.
\nFor a current list of domain name status codes and an explanation of what each code means, go to the\nICANN website and search for epp status codes.\n(Search on the ICANN website; web searches sometimes return an old version of the document.)
Type: Array of String
\n" + } + }, + "documentation": "\nThe GetDomainDetail response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + } + ], + "documentation": "\nThis operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
\nThe identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier\nin the response to the original request.
\nType: String
\nDefault: None
\nRequired: Yes
\n", + "required": true + } + }, + "documentation": "\nThe GetOperationDetail request includes the following element.
\n" + }, + "output": { + "shape_name": "GetOperationDetailResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nThe identifier for the operation.
\nType: String
\n" + }, + "Status": { + "shape_name": "OperationStatus", + "type": "string", + "enum": [ + "SUBMITTED", + "IN_PROGRESS", + "ERROR", + "SUCCESSFUL", + "FAILED" + ], + "documentation": "\nThe current status of the requested operation in the system.
\nType: String
\n" + }, + "Message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nDetailed information on the status including possible errors.
\nType: String
\n" + }, + "DomainName": { + "shape_name": "DomainName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe name of a domain.
\nType: String
\n" + }, + "Type": { + "shape_name": "OperationType", + "type": "string", + "enum": [ + "REGISTER_DOMAIN", + "DELETE_DOMAIN", + "TRANSFER_IN_DOMAIN", + "UPDATE_DOMAIN_CONTACT", + "UPDATE_NAMESERVER", + "CHANGE_PRIVACY_PROTECTION", + "DOMAIN_LOCK" + ], + "documentation": "\nThe type of operation that was requested.
\nType: String
\n" + }, + "SubmittedDate": { + "shape_name": "Timestamp", + "type": "timestamp", + "documentation": "\nThe date when the request was submitted.
\n" + } + }, + "documentation": "\nThe GetOperationDetail response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + } + ], + "documentation": "\nThis operation returns the current status of an operation that is not completed.
\nFor an initial request for a list of domains, omit this element. If the number of domains\nthat are associated with the current AWS account is greater than the value that you specified for\nMaxItems, you can use Marker to return additional domains. Get the value of\nNextPageMarker from the previous response, and submit another request that includes the\nvalue of NextPageMarker in the Marker element.
Type: String
\nDefault: None
\nConstraints: The marker must match the value specified in the previous request.
\nRequired: No
\n" + }, + "MaxItems": { + "shape_name": "PageMaxItems", + "type": "integer", + "max_length": 100, + "documentation": "\nNumber of domains to be returned.
\nType: Integer
\nDefault: 20
\nConstraints: A numeral between 1 and 100.
\nRequired: No
\n" + } + }, + "documentation": "\nThe ListDomains request includes the following elements.
\n" + }, + "output": { + "shape_name": "ListDomainsResponse", + "type": "structure", + "members": { + "Domains": { + "shape_name": "DomainSummaryList", + "type": "list", + "members": { + "shape_name": "DomainSummary", + "type": "structure", + "members": { + "DomainName": { + "shape_name": "DomainName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe name of a domain.
\nType: String
\n", + "required": true + }, + "AutoRenew": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the domain is automatically renewed upon expiration.
\nType: Boolean
\nValid values: True | False
Indicates whether a domain is locked from unauthorized transfer to another party.
\nType: Boolean
\nValid values: True | False
Expiration date of the domain in Coordinated Universal Time (UTC).
\nType: Long
\n" + } + }, + "documentation": null + }, + "documentation": "\nA summary of domains.
\nType: Complex type containing a list of domain summaries.
\nChildren: AutoRenew, DomainName,\nExpiry, TransferLock
If there are more domains than you specified for MaxItems in the request, submit another\nrequest and include the value of NextPageMarker in the value of Marker.
Type: String
\nParent: Operations
The ListDomains response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + } + ], + "documentation": "\nThis operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
\nFor an initial request for a list of operations, omit this element. If the number of operations that are\nnot yet complete is greater than the value that you specified for MaxItems, you can use Marker\nto return additional operations. Get the value of NextPageMarker from the previous response,\nand submit another request that includes the value of NextPageMarker in the Marker element.
Type: String
\nDefault: None
\nRequired: No
\n" + }, + "MaxItems": { + "shape_name": "PageMaxItems", + "type": "integer", + "max_length": 100, + "documentation": "\nNumber of domains to be returned.
\nType: Integer
\nDefault: 20
\nConstraints: A value between 1 and 100.
\nRequired: No
\n" + } + }, + "documentation": "\nThe ListOperations request includes the following elements.
\n" + }, + "output": { + "shape_name": "ListOperationsResponse", + "type": "structure", + "members": { + "Operations": { + "shape_name": "OperationSummaryList", + "type": "list", + "members": { + "shape_name": "OperationSummary", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier returned to track the requested action.
\nType: String
\n", + "required": true + }, + "Status": { + "shape_name": "OperationStatus", + "type": "string", + "enum": [ + "SUBMITTED", + "IN_PROGRESS", + "ERROR", + "SUCCESSFUL", + "FAILED" + ], + "documentation": "\nThe current status of the requested operation in the system.
\nType: String
\n", + "required": true + }, + "Type": { + "shape_name": "OperationType", + "type": "string", + "enum": [ + "REGISTER_DOMAIN", + "DELETE_DOMAIN", + "TRANSFER_IN_DOMAIN", + "UPDATE_DOMAIN_CONTACT", + "UPDATE_NAMESERVER", + "CHANGE_PRIVACY_PROTECTION", + "DOMAIN_LOCK" + ], + "documentation": "\nType of the action requested.
\nType: String
\nValid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK
The date when the request was submitted.
\n", + "required": true + } + }, + "documentation": "\nOperationSummary includes the following elements.
\n" + }, + "documentation": "\nLists summaries of the operations.
\nType: Complex type containing a list of operation summaries
\nChildren: OperationId, Status, SubmittedDate,\nType
If there are more operations than you specified for MaxItems in the request, submit another\nrequest and include the value of NextPageMarker in the value of Marker.
Type: String
\nParent: Operations
The ListOperations response includes the following elements.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + } + ], + "documentation": "\nThis operation returns the operation IDs of operations that are not yet complete.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "IdnLangCode": { + "shape_name": "LangCode", + "type": "string", + "max_length": 3, + "documentation": "\nReserved for future use.
\n" + }, + "DurationInYears": { + "shape_name": "DurationInYears", + "type": "integer", + "min_length": 1, + "max_length": 10, + "documentation": "\nThe 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.
\nType: Integer
\nDefault: 1
\nValid values: Integer from 1 to 10
\nRequired: Yes
\n", + "required": true + }, + "AutoRenew": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
Type: Boolean
\nValid values: true | false
Default: true
Required: No
\n" + }, + "AdminContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "RegistrantContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "TechContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "PrivacyProtectAdminContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + }, + "PrivacyProtectRegistrantContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + }, + "PrivacyProtectTechContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + } + }, + "documentation": "\nThe RegisterDomain request includes the following elements.
\n" + }, + "output": { + "shape_name": "RegisterDomainResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe RegisterDomain response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "UnsupportedTLD", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nAmazon Route 53 does not support this top-level domain.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "DomainLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of domains has exceeded the allowed threshold for the account.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation registers a domain. Domains are registered by the AWS registrar partner, Gandi.\nFor some top-level domains (TLDs), this operation requires extra parameters.
\nWhen you register a domain, Amazon Route 53 does the following:
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + } + }, + "documentation": "\nThe RetrieveDomainAuthCode request includes the following element.
\n" + }, + "output": { + "shape_name": "RetrieveDomainAuthCodeResponse", + "type": "structure", + "members": { + "AuthCode": { + "shape_name": "DomainAuthCode", + "type": "string", + "max_length": 1024, + "sensitive": true, + "documentation": "\nThe authorization code for the domain.
\nType: String
\n", + "required": true + } + }, + "documentation": "\nThe RetrieveDomainAuthCode response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + } + ], + "documentation": "\nThis operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "IdnLangCode": { + "shape_name": "LangCode", + "type": "string", + "max_length": 3, + "documentation": "\nReserved for future use.
\n" + }, + "DurationInYears": { + "shape_name": "DurationInYears", + "type": "integer", + "min_length": 1, + "max_length": 10, + "documentation": "\nThe 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.
\nType: Integer
\nDefault: 1
\nValid values: Integer from 1 to 10
\nRequired: Yes
\n", + "required": true + }, + "Nameservers": { + "shape_name": "NameserverList", + "type": "list", + "members": { + "shape_name": "Nameserver", + "type": "structure", + "members": { + "Name": { + "shape_name": "HostName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe fully qualified host name of the name server.
\nType: String
\nConstraint: Maximum 255 characterss
\nParent: Nameservers
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
\nType: List of IP addresses.
\nConstraints: The list can contain only one IPv4 and one IPv6 address.
\nParent: Nameservers
Nameserver includes the following elements.
\n" + }, + "documentation": "\nContains details for the host and glue IP addresses.
\nType: Complex
\nChildren: GlueIps, Name
The authorization code for the domain. You get this value from the current registrar.
\nType: String
\nRequired: Yes
\n" + }, + "AutoRenew": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nIndicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.
\nType: Boolean
\nValid values: true | false
Default: true
\nRequired: No
\n" + }, + "AdminContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "RegistrantContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "TechContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n", + "required": true + }, + "PrivacyProtectAdminContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + }, + "PrivacyProtectRegistrantContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + }, + "PrivacyProtectTechContact": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: true
Valid values: true | false
Required: No
\n\n" + } + }, + "documentation": "\nThe TransferDomain request includes the following elements.
\n" + }, + "output": { + "shape_name": "TransferDomainResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe TranserDomain response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "UnsupportedTLD", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nAmazon Route 53 does not support this top-level domain.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "DomainLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of domains has exceeded the allowed threshold for the account.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the\nAWS registrar, Gandi upon transfer.
\nTo transfer a domain, you need to meet all the domain transfer criteria, including the following:
\nWe recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted\nzone in Amazon Route 53 for your current domain before transferring your domain.
\nNote that upon transfer, the domain duration is extended for a year if not otherwise\nspecified. Autorenew is enabled by default.
\nIf the transfer is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.
\nTransferring domains charges your AWS account an amount based on the top-level domain. For more\ninformation, see Amazon Route 53 Pricing.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "AdminContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n" + }, + "RegistrantContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n" + }, + "TechContact": { + "shape_name": "ContactDetail", + "type": "structure", + "members": { + "FirstName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nFirst name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "LastName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nLast name of contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ContactType": { + "shape_name": "ContactType", + "type": "string", + "enum": [ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ], + "documentation": "\nIndicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than PERSON, you must enter an organization name, and you can't\nenable privacy protection for the contact.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nValid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY
Parents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "OrganizationName": { + "shape_name": "ContactName", + "type": "string", + "max_length": 255, + "documentation": "\nName of the organization for contact types other than PERSON.
Type: String
\nDefault: None
\nConstraints: Maximum 255 characters. Contact type must not be PERSON.
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "AddressLine1": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nFirst line of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "AddressLine2": { + "shape_name": "AddressLine", + "type": "string", + "max_length": 255, + "documentation": "\nSecond line of contact's address, if any.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "City": { + "shape_name": "City", + "type": "string", + "max_length": 255, + "documentation": "\nThe city of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "State": { + "shape_name": "State", + "type": "string", + "max_length": 255, + "documentation": "\nThe state or province of the contact's city.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "CountryCode": { + "shape_name": "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" + ], + "documentation": "\nCode for the country of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "ZipCode": { + "shape_name": "ZipCode", + "type": "string", + "max_length": 255, + "documentation": "\nThe zip or postal code of the contact's address.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\nParents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "PhoneNumber": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nThe phone number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: Yes
\n" + }, + "Email": { + "shape_name": "Email", + "type": "string", + "max_length": 254, + "documentation": "\nEmail address of the contact.
\nType: String
\nDefault: None
\nConstraints: Maximum 254 characters.
\nParents: RegistrantContact, AdminContact, TechContact\n
Required: Yes
\n" + }, + "Fax": { + "shape_name": "ContactNumber", + "type": "string", + "max_length": 30, + "documentation": "\nFax number of the contact.
\nType: String
\nDefault: None
\nConstraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as \"+1.1234567890\".
Parents: RegistrantContact, AdminContact, TechContact
Required: No
\n" + }, + "ExtraParams": { + "shape_name": "ExtraParamList", + "type": "list", + "members": { + "shape_name": "ExtraParam", + "type": "structure", + "members": { + "Name": { + "shape_name": "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", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "IT_PIN", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER" + ], + "documentation": "\nName of the additional parameter required by the top-level domain.
\nType: String
\nDefault: None
\nValid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT |\nBIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY |\nDOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE |\nFI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA |\nSE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER
Parent: ExtraParams
Required: Yes
\n", + "required": true + }, + "Value": { + "shape_name": "ExtraParamValue", + "type": "string", + "max_length": 2048, + "documentation": "\nValues corresponding to the additional parameter names required by some top-level\ndomains.
\nType: String
\nDefault: None
\nConstraints: Maximum 2048 characters.
\nParent: ExtraParams
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nExtraParam includes the following elements.
\n" + }, + "documentation": "\nA list of name-value pairs for parameters required by certain top-level\ndomains.
\nType: Complex
\nDefault: None
\nParents: RegistrantContact, AdminContact, TechContact
Children: Name, Value
Required: No
\n" + } + }, + "sensitive": true, + "documentation": "\nProvides detailed contact information.
\nType: Complex
\nChildren: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams
Required: Yes
\n" + } + }, + "documentation": "\nThe UpdateDomainContact request includes the following elements.
\n" + }, + "output": { + "shape_name": "UpdateDomainContactResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe UpdateDomainContact response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation updates the contact information for a particular domain.\nInformation for at least one contact (registrant, administrator, or technical) must be\nsupplied for update.
\nIf the update is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "AdminPrivacy": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: None
\nValid values: true | false
Required: No
\n\n" + }, + "RegistrantPrivacy": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: None
\nValid values: true | false
Required: No
\n\n" + }, + "TechPrivacy": { + "shape_name": "Boolean", + "type": "boolean", + "documentation": "\nWhether 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.
\nType: Boolean
\nDefault: None
\nValid values: true | false
Required: No
\n\n" + } + }, + "documentation": "\nThe UpdateDomainContactPrivacy request includes the following elements.
\n" + }, + "output": { + "shape_name": "UpdateDomainContactPrivacyResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe UpdateDomainContactPrivacy response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation updates the specified domain contact's privacy setting. When the privacy\noption is enabled, personal information such as postal or email address is hidden from the\nresults of a public WHOIS query. The privacy services are provided by the AWS registrar,\nGandi. For more information, see the Gandi privacy\nfeatures.
\nThis 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.
\nThe name of a domain.
\nType: String
\nDefault: None
\nConstraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.
\nRequired: Yes
\n", + "required": true + }, + "Nameservers": { + "shape_name": "NameserverList", + "type": "list", + "members": { + "shape_name": "Nameserver", + "type": "structure", + "members": { + "Name": { + "shape_name": "HostName", + "type": "string", + "max_length": 255, + "pattern": "[a-zA-Z0-9_\\-.]*", + "documentation": "\nThe fully qualified host name of the name server.
\nType: String
\nConstraint: Maximum 255 characterss
\nParent: Nameservers
Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.
\nType: List of IP addresses.
\nConstraints: The list can contain only one IPv4 and one IPv6 address.
\nParent: Nameservers
Nameserver includes the following elements.
\n" + }, + "documentation": "\nA list of new name servers for the domain.
\nType: Complex
\nChildren: Name, GlueIps
Required: Yes
\n", + "required": true + } + }, + "documentation": "\nThe UpdateDomainNameserver request includes the following elements.
\n" + }, + "output": { + "shape_name": "UpdateDomainNameserversResponse", + "type": "structure", + "members": { + "OperationId": { + "shape_name": "OperationId", + "type": "string", + "max_length": 255, + "documentation": "\nIdentifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.
\nType: String
\nDefault: None
\nConstraints: Maximum 255 characters.
\n", + "required": true + } + }, + "documentation": "\nThe UpdateDomainNameservers response includes the following element.
\n" + }, + "errors": [ + { + "shape_name": "InvalidInput", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe 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.
\n" + }, + { + "shape_name": "DuplicateRequest", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe request is already in progress for the domain.
\n" + }, + { + "shape_name": "TLDRulesViolation", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe top-level domain does not support this operation.
\n" + }, + { + "shape_name": "OperationLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": null + } + }, + "documentation": "\nThe number of operations or jobs running exceeded the allowed threshold for the account.
\n" + } + ], + "documentation": "\nThis operation replaces the current set of name servers for the domain with the specified set of name servers.\nIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone\nfor the domain.
\nIf successful, this operation returns an operation ID that you can use to track the progress and completion of the action.\nIf the request is not completed successfully, the domain registrant will be notified by email.
\nThe AWS Support API reference is intended for programmers who need detailed information about the AWS Support actions and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.
\n \nThe 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.
\n \nThe following list describes the AWS Support case management actions:
\nThe following list describes the actions available from the AWS Support service for Trusted Advisor:
\nFor authentication of requests, AWS Support uses Signature Version 4 Signing Process.
\n \nSee 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.
\n \n \n ", + "documentation": "\nThe 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.
\n \nThe 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.
\n \nThe following list describes the AWS Support case management operations:
\nThe following list describes the operations available from the AWS Support service for Trusted Advisor:
\nCheckId 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.
\n \nSee 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.
\n \n \n ", "operations": { + "AddAttachmentsToSet": { + "name": "AddAttachmentsToSet", + "input": { + "shape_name": "AddAttachmentsToSetRequest", + "type": "structure", + "members": { + "attachmentSetId": { + "shape_name": "AttachmentSetId", + "type": "string", + "documentation": "\nThe 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 name of the attachment file.
\n " + }, + "data": { + "shape_name": "Data", + "type": "blob", + "documentation": "\nThe content of the attachment file.
\n " + } + }, + "documentation": "\nAn attachment to a case communication. The attachment consists of the file name and the content of the file.
\n " + }, + "documentation": "\nOne or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.
\n ", + "required": true + } + }, + "documentation": "\n\n " + }, + "output": { + "shape_name": "AddAttachmentsToSetResponse", + "type": "structure", + "members": { + "attachmentSetId": { + "shape_name": "AttachmentSetId", + "type": "string", + "documentation": "\nThe 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 time and date when the attachment set expires.
\n " + } + }, + "documentation": "\nThe ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.
\n " + }, + "errors": [ + { + "shape_name": "InternalServerError", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nAn internal server error occurred.
\n " + } + }, + "documentation": "\nAn internal server error occurred.
\n " + }, + { + "shape_name": "AttachmentSetIdNotFound", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nAn attachment set with the specified ID could not be found.
\n " + } + }, + "documentation": "\nAn attachment set with the specified ID could not be found.
\n " + }, + { + "shape_name": "AttachmentSetExpired", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " + } + }, + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " + }, + { + "shape_name": "AttachmentSetSizeLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nA limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
\n " + } + }, + "documentation": "\nA limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.
\n " + }, + { + "shape_name": "AttachmentLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nThe limit for the number of attachment sets created in a short period of time has been exceeded.
\n " + } + }, + "documentation": "\nThe limit for the number of attachment sets created in a short period of time has been exceeded.
\n " + } + ], + "documentation": "\nAdds 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.
The email addresses in the CC line of an email to be added to the support case.
\n " + }, + "attachmentSetId": { + "shape_name": "AttachmentSetId", + "type": "string", + "documentation": "\nThe ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet
\n " } }, "documentation": "\nTo be written.
\n " @@ -53,7 +176,7 @@ "documentation": "\nTrue if AddCommunicationToCase succeeds. Otherwise, returns an error.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe result of the AddCommunicationToCase operation.
\n " }, "errors": [ { @@ -79,6 +202,30 @@ } }, "documentation": "\nThe requested CaseId could not be located.
An attachment set with the specified ID could not be found.
\n " + } + }, + "documentation": "\nAn attachment set with the specified ID could not be found.
\n " + }, + { + "shape_name": "AttachmentSetExpired", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " + } + }, + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " } ], "documentation": "\nAdds 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.
\nThis operation implements a subset of the behavior on the AWS Support Your Support Cases web form.
\n " @@ -140,6 +287,11 @@ "shape_name": "IssueType", "type": "string", "documentation": "\nThe 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.\"
\n " + }, + "attachmentSetId": { + "shape_name": "AttachmentSetId", + "type": "string", + "documentation": "\nThe ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.
\n " } }, "documentation": "\n \n " @@ -154,7 +306,7 @@ "documentation": "\nThe 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
\n " } }, - "documentation": "\nThe AWS Support case ID returned by a successful completion of the CreateCase action.
\n " + "documentation": "\nThe AWS Support case ID returned by a successful completion of the CreateCase operation.
\n " }, "errors": [ { @@ -180,9 +332,112 @@ } }, "documentation": "\nThe case creation limit for the account has been exceeded.
\n " + }, + { + "shape_name": "AttachmentSetIdNotFound", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nAn attachment set with the specified ID could not be found.
\n " + } + }, + "documentation": "\nAn attachment set with the specified ID could not be found.
\n " + }, + { + "shape_name": "AttachmentSetExpired", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " + } + }, + "documentation": "\nThe expiration time of the attachment set has passed. The set expires 1 hour after it is created.
\n " } ], - "documentation": "\nCreates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:
\nServiceCode 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. The AWS Support API does not currently support the ability to add attachments to cases. You can, however, call AddCommunicationToCase to add information to an open case.
A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases action to retrieve existing AWS Support cases.
\n \n \n " + "documentation": "\nCreates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Open a new case page. Its parameters require you to specify the following information:
\nServiceCode 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.
\n \n \n " + }, + "DescribeAttachment": { + "name": "DescribeAttachment", + "input": { + "shape_name": "DescribeAttachmentRequest", + "type": "structure", + "members": { + "attachmentId": { + "shape_name": "AttachmentId", + "type": "string", + "documentation": "\nThe ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.
\n ", + "required": true + } + }, + "documentation": "\n\n " + }, + "output": { + "shape_name": "DescribeAttachmentResponse", + "type": "structure", + "members": { + "attachment": { + "shape_name": "Attachment", + "type": "structure", + "members": { + "fileName": { + "shape_name": "FileName", + "type": "string", + "documentation": "\nThe name of the attachment file.
\n " + }, + "data": { + "shape_name": "Data", + "type": "blob", + "documentation": "\nThe content of the attachment file.
\n " + } + }, + "documentation": "\nThe attachment content and file name.
\n " + } + }, + "documentation": "\nThe content and file name of the attachment returned by the DescribeAttachment operation.
\n " + }, + "errors": [ + { + "shape_name": "InternalServerError", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nAn internal server error occurred.
\n " + } + }, + "documentation": "\nAn internal server error occurred.
\n " + }, + { + "shape_name": "DescribeAttachmentLimitExceeded", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nThe limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
\n " + } + }, + "documentation": "\nThe limit for the number of DescribeAttachment requests in a short period of time has been exceeded.
\n " + }, + { + "shape_name": "AttachmentIdNotFound", + "type": "structure", + "members": { + "message": { + "shape_name": "ErrorMessage", + "type": "string", + "documentation": "\nAn attachment with the specified ID could not be found.
\n " + } + }, + "documentation": "\nAn attachment with the specified ID could not be found.
\n " + } + ], + "documentation": "\nReturns 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.
\n " }, "DescribeCases": { "name": "DescribeCases", @@ -210,17 +465,17 @@ "afterTime": { "shape_name": "AfterTime", "type": "string", - "documentation": "\nThe start date for a filtered date search on support case communications.
\n " + "documentation": "\nThe start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
\n " }, "beforeTime": { "shape_name": "BeforeTime", "type": "string", - "documentation": "\nThe end date for a filtered date search on support case communications.
\n " + "documentation": "\nThe end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
\n " }, "includeResolvedCases": { "shape_name": "IncludeResolvedCases", "type": "boolean", - "documentation": "\nSpecifies whether resolved support cases should be included in the DescribeCases results.
\n " + "documentation": "\nSpecifies whether resolved support cases should be included in the DescribeCases results. The default is false.
\n " }, "nextToken": { "shape_name": "NextToken", @@ -238,6 +493,11 @@ "shape_name": "Language", "type": "string", "documentation": "\nThe 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.
\n " + }, + "includeCommunications": { + "shape_name": "IncludeCommunications", + "type": "boolean", + "documentation": "\nSpecifies whether communications should be included in the DescribeCases results. The default is true.
\n " } }, "documentation": "\n \n " @@ -327,10 +587,32 @@ "timeCreated": { "shape_name": "TimeCreated", "type": "string", - "documentation": "\nThe time the support case was created.
\n " + "documentation": "\nThe time the communication was created.
\n " + }, + "attachmentSet": { + "shape_name": "AttachmentSet", + "type": "list", + "members": { + "shape_name": "AttachmentDetails", + "type": "structure", + "members": { + "attachmentId": { + "shape_name": "AttachmentId", + "type": "string", + "documentation": "\nThe ID of the attachment.
\n" + }, + "fileName": { + "shape_name": "FileName", + "type": "string", + "documentation": "\nThe file name of the attachment.
\n" + } + }, + "documentation": "\nThe file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
\n" + }, + "documentation": "\nInformation about the attachments to the case communication.
\n " } }, - "documentation": "\nExposes the fields used by a communication for an AWS Support case.
\n " + "documentation": "\nA 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.
\n " }, "documentation": "\nThe five most recent communications associated with the case.
\n " }, @@ -340,7 +622,7 @@ "documentation": "\nA resumption point for pagination.
\n " } }, - "documentation": "\nThe five most recent communications between you and AWS Support Center. Includes a nextToken to retrieve the next set of communications.
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 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.
\n " } }, - "documentation": "\nA 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:
\nBody, CaseId, SubmittedBy, and TimeCreated.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:
\nAttachments, Body, CaseId, SubmittedBy, and TimeCreated.The details for the cases that match the request.
\n " }, @@ -396,7 +678,7 @@ "documentation": "\nThe requested CaseId could not be located.
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.
The response returns the following in JSON format:
\nNextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.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.
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.
\nThe response returns the following in JSON format:
\nNextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.The end date for a filtered date search on support case communications.
\n " + "documentation": "\nThe end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
\n " }, "afterTime": { "shape_name": "AfterTime", "type": "string", - "documentation": "\nThe start date for a filtered date search on support case communications.
\n " + "documentation": "\nThe start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.
\n " }, "nextToken": { "shape_name": "NextToken", @@ -471,10 +753,32 @@ "timeCreated": { "shape_name": "TimeCreated", "type": "string", - "documentation": "\nThe time the support case was created.
\n " + "documentation": "\nThe time the communication was created.
\n " + }, + "attachmentSet": { + "shape_name": "AttachmentSet", + "type": "list", + "members": { + "shape_name": "AttachmentDetails", + "type": "structure", + "members": { + "attachmentId": { + "shape_name": "AttachmentId", + "type": "string", + "documentation": "\nThe ID of the attachment.
\n" + }, + "fileName": { + "shape_name": "FileName", + "type": "string", + "documentation": "\nThe file name of the attachment.
\n" + } + }, + "documentation": "\nThe file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.
\n" + }, + "documentation": "\nInformation about the attachments to the case communication.
\n " } }, - "documentation": "\nExposes the fields used by a communication for an AWS Support case.
\n " + "documentation": "\nA 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.
\n " }, "documentation": "\nThe communications for the case.
\n " }, @@ -484,7 +788,7 @@ "documentation": "\nA resumption point for pagination.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe communications returned by the DescribeCommunications operation.
\n " }, "errors": [ { @@ -512,7 +816,7 @@ "documentation": "\nThe requested CaseId could not be located.
Returns communications regarding the support case. You can use the AfterTime and BeforeTime parameters to filter by date. The CaseId parameter enables you to identify a specific case by its CaseId value.
The MaxResults and NextToken parameters enable you 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 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.
\nYou 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.
The code for an AWS service returned by DescribeServices response. Has a corresponding name represented by Service.name.
\n " + "documentation": "\nThe code for an AWS service returned by the DescribeServices response. The Name element contains the corresponding friendly name.
The friendly name for an AWS service. Has a corresponding code represented by Service.code.
\n " + "documentation": "\nThe friendly name for an AWS service. The Code element contains the corresponding code.
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.
\n " } }, - "documentation": "\nRepresents an AWS Service returned by the DescribeServices action.
\n " + "documentation": "\nInformation about an AWS service returned by the DescribeServices operation.
\n " }, "documentation": "\nA JSON-formatted list of AWS services.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe list of AWS services returned by the DescribeServices operation.
\n " }, "errors": [ { @@ -613,7 +917,7 @@ "documentation": "\nAn internal server error occurred.
\n " } ], - "documentation": "\nReturns 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.
\n \nThe service codes and category codes correspond to the values that are displayed in the\n Service and Category drop-down lists on the AWS Support Center Open a new case page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n DescribeServices request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service\n and category codes.
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.
\n \nThe 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 Open a new case page. The values in those\n fields, however, do not necessarily match the service codes and categories returned by the\n DescribeServices request. Always use the service codes and categories obtained\n programmatically. This practice ensures that you always have the most recent set of service and category codes.
The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe list of severity levels returned by the DescribeSeverityLevels operation.
\n " }, "errors": [ { @@ -730,7 +1034,7 @@ "required": true } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.
\n " }, "errors": [ { @@ -891,7 +1195,7 @@ "type": "string", "documentation": null }, - "documentation": "\nAdditional 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.
\n ", + "documentation": "\nAdditional 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.
\n ", "required": true } }, @@ -904,7 +1208,7 @@ "documentation": "\nThe detailed results of the Trusted Advisor check.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.
\n " }, "errors": [ { @@ -1042,7 +1346,7 @@ "required": true } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.
\n " }, "errors": [ { @@ -1118,7 +1422,7 @@ "type": "string", "documentation": null }, - "documentation": "\nThe 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.
\n ", + "documentation": "\nThe 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.
\n ", "required": true } }, @@ -1128,7 +1432,7 @@ "required": true } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nInformation about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.
\n " }, "errors": [ { @@ -1239,7 +1543,7 @@ "documentation": "\nThe status of the case after the ResolveCase request was processed.
\n " } }, - "documentation": "\nContains the following objects or data if successful. Otherwise, returns an error.
\n " + "documentation": "\nThe status of the case returned by the ResolveCase operation.
\n " }, "errors": [ { diff --git a/botocore/data/aws/swf/2012-01-25.json b/botocore/data/aws/swf/2012-01-25.json index cd40204d..3ce8726a 100644 --- a/botocore/data/aws/swf/2012-01-25.json +++ b/botocore/data/aws/swf/2012-01-25.json @@ -7278,6 +7278,13 @@ "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "events", + "non_aggregate_keys": [ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "previousStartedEventId" + ], "py_input_token": "next_page_token" } }, @@ -8837,6 +8844,13 @@ "input_token": "nextPageToken", "output_token": "nextPageToken", "result_key": "events", + "non_aggregate_keys": [ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "previousStartedEventId" + ], "py_input_token": "next_page_token" } }, diff --git a/botocore/endpoint.py b/botocore/endpoint.py index 578cadd9..0a2ec91e 100644 --- a/botocore/endpoint.py +++ b/botocore/endpoint.py @@ -30,6 +30,7 @@ from botocore.compat import urljoin, json, quote logger = logging.getLogger(__name__) +DEFAULT_TIMEOUT = 60 class Endpoint(object): @@ -44,7 +45,7 @@ class Endpoint(object): """ def __init__(self, service, region_name, host, auth, proxies=None, - verify=True): + verify=True, timeout=DEFAULT_TIMEOUT): self.service = service self.session = self.service.session self.region_name = region_name @@ -55,6 +56,7 @@ class Endpoint(object): proxies = {} self.proxies = proxies self.http_session = Session() + self.timeout = timeout self._lock = threading.Lock() def __repr__(self): @@ -127,7 +129,7 @@ class Endpoint(object): http_response = self.http_session.send( request, verify=self.verify, stream=operation.is_streaming(), - proxies=self.proxies) + proxies=self.proxies, timeout=self.timeout) except Exception as e: logger.debug("Exception received when sending HTTP request.", exc_info=True) @@ -267,7 +269,8 @@ def get_endpoint(service, region_name, endpoint_url, verify=None): service_style=service.type) service_name = getattr(service, 'signing_name', service.endpoint_prefix) auth = None - if hasattr(service, 'signature_version'): + if hasattr(service, 'signature_version') and \ + service.signature_version is not None: auth = _get_auth(service.signature_version, credentials=service.session.get_credentials(), service_name=service_name, diff --git a/botocore/exceptions.py b/botocore/exceptions.py index db155ce7..b0c2c509 100644 --- a/botocore/exceptions.py +++ b/botocore/exceptions.py @@ -61,7 +61,7 @@ class PartialCredentialsError(BotoCoreError): :ivar cred_var: The missing credential variable name. """ - fmt = 'Partial credentials found, missing: {cred_var}' + fmt = 'Partial credentials found in {provider}, missing: {cred_var}' class NoRegionError(BotoCoreError): diff --git a/botocore/parameters.py b/botocore/parameters.py index 7e632060..4b331431 100644 --- a/botocore/parameters.py +++ b/botocore/parameters.py @@ -399,14 +399,14 @@ class ListParameter(Parameter): inner_xml = '' for item in value: xmlname = self.xmlname - if not xmlname: + if self.members.xmlname: xmlname = self.members.xmlname inner_xml += self.members.to_xml(item, xmlname) if self.flattened: return inner_xml else: if not label: - label = self.xmlname + label = self.xmlname or self.name return '<%s>' % label + inner_xml + '' % label @@ -565,7 +565,7 @@ class StructParameter(Parameter): xml += '>' for member in self.members: if member.name in value and not hasattr(member, 'xmlattribute'): - xml += member.to_xml(value[member.name], member.name) + xml += member.to_xml(value[member.name], member.get_label()) xml += '' % label return xml diff --git a/botocore/retryhandler.py b/botocore/retryhandler.py index cd265be6..857916e3 100644 --- a/botocore/retryhandler.py +++ b/botocore/retryhandler.py @@ -17,7 +17,7 @@ import functools import logging from binascii import crc32 -from botocore.vendored.requests import ConnectionError +from botocore.vendored.requests import ConnectionError, Timeout from botocore.vendored.requests.packages.urllib3.exceptions import ClosedPoolError from botocore.exceptions import ChecksumError @@ -29,7 +29,7 @@ logger = logging.getLogger(__name__) # to get more specific exceptions from requests we can update # this mapping with more specific exceptions. EXCEPTION_MAP = { - 'GENERAL_CONNECTION_ERROR': [ConnectionError, ClosedPoolError], + 'GENERAL_CONNECTION_ERROR': [ConnectionError, ClosedPoolError, Timeout], } diff --git a/botocore/translate.py b/botocore/translate.py index 56300537..eb722785 100644 --- a/botocore/translate.py +++ b/botocore/translate.py @@ -20,7 +20,7 @@ from copy import deepcopy import jmespath from botocore.compat import OrderedDict, json -from botocore.utils import set_value_from_jmespath, merge_dicts +from botocore.utils import merge_dicts from botocore import xform_name @@ -79,9 +79,11 @@ def translate(model): new_model, model.enhancements.get('waiters', {})) # Merge in any per operation overrides defined in the .extras.json file. - merge_dicts(new_model['operations'], model.enhancements.get('operations', {})) + merge_dicts(new_model['operations'], + model.enhancements.get('operations', {})) add_retry_configs( - new_model, model.retry.get('retry', {}), definitions=model.retry.get('definitions', {})) + new_model, model.retry.get('retry', {}), + definitions=model.retry.get('definitions', {})) return new_model @@ -160,13 +162,13 @@ def _filter_param_doc(param, replacement, regex): def handle_filter_documentation(new_model, enhancements): - #This provides a way to filter undesireable content (e.g. CDATA) - #from documentation strings - filter = enhancements.get('transformations', {}).get( + # This provides a way to filter undesireable content (e.g. CDATA) + # from documentation strings. + doc_filter = enhancements.get('transformations', {}).get( 'filter-documentation', {}).get('filter') - if filter is not None: - filter_regex = re.compile(filter.get('regex', ''), re.DOTALL) - replacement = filter.get('replacement') + if doc_filter is not None: + filter_regex = re.compile(doc_filter.get('regex', ''), re.DOTALL) + replacement = doc_filter.get('replacement') operations = new_model['operations'] for op_name in operations: operation = operations[op_name] @@ -200,9 +202,8 @@ def handle_rename_params(new_model, enhancements): def resembles_jmespath_exp(value): # For now, we'll do a naive check. - if '.' in value: + if '.' in value or '[' in value: return True - return False @@ -218,44 +219,47 @@ def add_pagination_configs(new_model, pagination): config = pagination[name] _check_known_pagination_keys(config) if 'py_input_token' not in config: - input_token = config['input_token'] - if isinstance(input_token, list): - py_input_token = [] - for token in input_token: - py_input_token.append(xform_name(token)) - config['py_input_token'] = py_input_token - else: - config['py_input_token'] = xform_name(input_token) - # result_key must be defined - if 'result_key' not in config: - raise ValueError("Required key 'result_key' is missing from " - "from pagination config: %s" % config) - if name not in new_model['operations']: - raise ValueError("Trying to add pagination config for non " - "existent operation: %s" % name) - operation = new_model['operations'].get(name) - # result_key must match a key in the output. - if not isinstance(config['result_key'], list): - result_keys = [config['result_key']] - else: - result_keys = config['result_key'] - if result_keys and not operation['output']: - raise ValueError("Trying to add pagination config for an " - "operation with no output members: %s" % name) - for result_key in result_keys: - if resembles_jmespath_exp(result_key): - continue - if result_key not in operation['output']['members']: - raise ValueError("result_key %r is not an output member: %s" % - (result_key, - operation['output']['members'].keys())) + _add_py_input_token(config) + _validate_result_key_exists(config) + _validate_referenced_operation_exists(new_model, name) + operation = new_model['operations'][name] + _validate_operation_has_output(operation, name) _check_input_keys_match(config, operation) - if operation is None: - raise ValueError("Tried to add a pagination config for non " - "existent operation '%s'" % name) + _check_output_keys_match(config, operation, + new_model.get('endpoint_prefix', '')) operation['pagination'] = config.copy() +def _validate_operation_has_output(operation, name): + if not operation['output']: + raise ValueError("Trying to add pagination config for an " + "operation with no output members: %s" % name) + + +def _validate_referenced_operation_exists(new_model, name): + if name not in new_model['operations']: + raise ValueError("Trying to add pagination config for non " + "existent operation: %s" % name) + + +def _validate_result_key_exists(config): + # result_key must be defined. + if 'result_key' not in config: + raise ValueError("Required key 'result_key' is missing from " + "from pagination config: %s" % config) + + +def _add_py_input_token(config): + input_token = config['input_token'] + if isinstance(input_token, list): + py_input_token = [] + for token in input_token: + py_input_token.append(xform_name(token)) + config['py_input_token'] = py_input_token + else: + config['py_input_token'] = xform_name(input_token) + + def add_waiter_configs(new_model, waiters): if waiters: denormalized = denormalize_waiters(waiters) @@ -335,18 +339,18 @@ def denormalize_single_waiter(value, default, waiters): # want to completely remove the acceptor types. # The logic here is that if there is no success/failure_* variable # defined, it inherits this value from the matching acceptor_* variable. - new_waiter['success_type'] = new_waiter.get('success_type', - new_waiter.get('acceptor_type')) - new_waiter['success_path'] = new_waiter.get('success_path', - new_waiter.get('acceptor_path')) - new_waiter['success_value'] = new_waiter.get('success_value', - new_waiter.get('acceptor_value')) - new_waiter['failure_type'] = new_waiter.get('failure_type', - new_waiter.get('acceptor_type')) - new_waiter['failure_path'] = new_waiter.get('failure_path', - new_waiter.get('acceptor_path')) - new_waiter['failure_value'] = new_waiter.get('failure_value', - new_waiter.get('acceptor_value')) + new_waiter['success_type'] = new_waiter.get( + 'success_type', new_waiter.get('acceptor_type')) + new_waiter['success_path'] = new_waiter.get( + 'success_path', new_waiter.get('acceptor_path')) + new_waiter['success_value'] = new_waiter.get( + 'success_value', new_waiter.get('acceptor_value')) + new_waiter['failure_type'] = new_waiter.get( + 'failure_type', new_waiter.get('acceptor_type')) + new_waiter['failure_path'] = new_waiter.get( + 'failure_path', new_waiter.get('acceptor_path')) + new_waiter['failure_value'] = new_waiter.get( + 'failure_value', new_waiter.get('acceptor_value')) # We can remove acceptor_* vars because they're only used for lookups # and we've already performed this step in the lines above. new_waiter.pop('acceptor_type', '') @@ -360,11 +364,11 @@ def denormalize_single_waiter(value, default, waiters): for required in ['operation', 'success_type']: if required not in new_waiter: raise ValueError('Missing required waiter configuration ' - 'value "%s": %s' % (required, new_waiter)) + 'value "%s": %s' % (required, new_waiter)) if new_waiter.get(required) is None: raise ValueError('Required waiter configuration ' - 'value cannot be None "%s": %s' - % (required, new_waiter)) + 'value cannot be None "%s": %s' % + (required, new_waiter)) # Finally, success/failure values can be a scalar or a list. We're going # to just always make them a list. if 'success_value' in new_waiter and not \ @@ -406,6 +410,57 @@ def _check_known_pagination_keys(config): raise ValueError("Unknown key in pagination config: %s" % key) +def _check_output_keys_match(config, operation, service_name): + output_members = list(operation['output']['members']) + jmespath_seen = False + for output_key in _get_all_page_output_keys(config): + if resembles_jmespath_exp(output_key): + # We don't validate jmespath expressions for now. + jmespath_seen = True + continue + if output_key not in output_members: + raise ValueError("Key %r is not an output member: %s" % + (output_key, + output_members)) + output_members.remove(output_key) + # Some services echo the input parameters in the response + # output. We should not trigger a validation error + # if those params are still not accounted for. + for input_name in operation['input']['members']: + if input_name in output_members: + output_members.remove(input_name) + if not jmespath_seen and output_members: + # Because we can't validate jmespath expressions yet, + # we can't say for user if output_members actually has + # remaining keys or not. + if service_name == 's3' and output_members == ['Name']: + # The S3 model uses 'Name' for the output key, which + # actually maps to the 'Bucket' input param so we don't + # need to validate this output member. This is the only + # model that has this, so we can just special case this + # for now. + return + raise ValueError("Output members still exist for operation %s: %s" % ( + operation['name'], output_members)) + + +def _get_all_page_output_keys(config): + if not isinstance(config['result_key'], list): + yield config['result_key'] + else: + for result_key in config['result_key']: + yield result_key + if not isinstance(config['output_token'], list): + yield config['output_token'] + else: + for result_key in config['output_token']: + yield result_key + if 'more_results' in config: + yield config['more_results'] + for key in config.get('non_aggregate_keys', []): + yield key + + def _check_input_keys_match(config, operation): input_tokens = config['input_token'] if not isinstance(input_tokens, list): diff --git a/botocore/utils.py b/botocore/utils.py index e93644ef..95b8757b 100644 --- a/botocore/utils.py +++ b/botocore/utils.py @@ -12,10 +12,11 @@ # language governing permissions and limitations under the License. import logging +from six import string_types, text_type -from .exceptions import InvalidExpressionError, ConfigNotFound -from .compat import json -from .vendored import requests +from botocore.exceptions import InvalidExpressionError, ConfigNotFound +from botocore.compat import json, quote +from botocore.vendored import requests logger = logging.getLogger(__name__) @@ -23,6 +24,9 @@ DEFAULT_METADATA_SERVICE_TIMEOUT = 1 METADATA_SECURITY_CREDENTIALS_URL = ( 'http://169.254.169.254/latest/meta-data/iam/security-credentials/' ) +# These are chars that do not need to be urlencoded. +# Based on rfc2986, section 2.3 +SAFE_CHARS = '-._~' class _RetriesExceededError(Exception): @@ -223,3 +227,43 @@ def parse_key_val_file_contents(contents): val = val.strip() final[key] = val return final + + +def percent_encode_sequence(mapping, safe=SAFE_CHARS): + """Urlencode a dict or list into a string. + + This is similar to urllib.urlencode except that: + + * It uses quote, and not quote_plus + * It has a default list of safe chars that don't need + to be encoded, which matches what AWS services expect. + + This function should be preferred over the stdlib + ``urlencode()`` function. + + :param mapping: Either a dict to urlencode or a list of + ``(key, value)`` pairs. + + """ + encoded_pairs = [] + if hasattr(mapping, 'items'): + pairs = mapping.items() + else: + pairs = mapping + for key, value in pairs: + encoded_pairs.append('%s=%s' % (percent_encode(key), + percent_encode(value))) + return '&'.join(encoded_pairs) + + +def percent_encode(input_str, safe=SAFE_CHARS): + """Urlencodes a string. + + Whereas percent_encode_sequence handles taking a dict/sequence and + producing a percent encoded string, this function deals only with + taking a string (not a dict/sequence) and percent encoding it. + + """ + if not isinstance(input_str, string_types): + input_str = text_type(input_str) + return quote(text_type(input_str), safe=safe)