Codebase list golang-github-aws-aws-sdk-go / bbdb97c
Imported Upstream version 0.9.9+dfsg Dmitry Smirnov 8 years ago
89 changed file(s) with 6013 addition(s) and 2769 deletion(s). Raw diff Collapse all Expand all
+19
-0
apis/ec2/2015-04-15/api-2.json less more
17841784 "shape":"String",
17851785 "locationName":"AllocationId"
17861786 }
1787 },
1788 "AllocationStrategy":{
1789 "type":"string",
1790 "enum":[
1791 "lowestPrice",
1792 "diversified"
1793 ]
17871794 },
17881795 "ArchitectureValues":{
17891796 "type":"string",
1025210259 "shape":"SnapshotState",
1025310260 "locationName":"status"
1025410261 },
10262 "StateMessage":{
10263 "shape":"String",
10264 "locationName":"statusMessage"
10265 },
1025510266 "StartTime":{
1025610267 "shape":"DateTime",
1025710268 "locationName":"startTime"
1028710298 "KmsKeyId":{
1028810299 "shape":"String",
1028910300 "locationName":"kmsKeyId"
10301 },
10302 "DataEncryptionKeyId":{
10303 "shape":"String",
10304 "locationName":"dataEncryptionKeyId"
1029010305 }
1029110306 }
1029210307 },
1059010605 "LaunchSpecifications":{
1059110606 "shape":"LaunchSpecsList",
1059210607 "locationName":"launchSpecifications"
10608 },
10609 "AllocationStrategy":{
10610 "shape":"AllocationStrategy",
10611 "locationName":"allocationStrategy"
1059310612 }
1059410613 }
1059510614 },
+71
-63
apis/ec2/2015-04-15/docs-2.json less more
2020 "CancelImportTask": "<p>Cancels an in-process import virtual machine or import snapshot task.</p>",
2121 "CancelReservedInstancesListing": "<p>Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html\">Reserved Instance Marketplace</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
2222 "CancelSpotFleetRequests": "<p>Cancels the specified Spot fleet requests.</p>",
23 "CancelSpotInstanceRequests": "<p>Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <important> <p>Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.</p> </important>",
23 "CancelSpotInstanceRequests": "<p>Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <important> <p>Canceling a Spot instance request does not terminate running Spot instances associated with the request.</p> </important>",
2424 "ConfirmProductInstance": "<p>Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.</p>",
2525 "CopyImage": "<p>Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html\">Copying AMIs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
2626 "CopySnapshot": "<p>Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.</p> <p>Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the <code>Encrypted</code> flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the <code>KmsKeyId</code> parameter.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-copy-snapshot.html\">Copying an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
4040 "CreateRouteTable": "<p>Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.</p> <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
4141 "CreateSecurityGroup": "<p>Creates a security group.</p> <p>A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <important> <p>EC2-Classic: You can have up to 500 security groups.</p> <p>EC2-VPC: You can create up to 100 security groups per VPC.</p> </important> <p>When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.</p> <p>You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.</p> <p>You can add or remove rules from your security groups using <a>AuthorizeSecurityGroupIngress</a>, <a>AuthorizeSecurityGroupEgress</a>, <a>RevokeSecurityGroupIngress</a>, and <a>RevokeSecurityGroupEgress</a>.</p>",
4242 "CreateSnapshot": "<p>Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.</p> <p>When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.</p> <p>You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is <code>pending</code>.</p> <p>To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.</p> <p>Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html\">Amazon Elastic Block Store</a> and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
43 "CreateSpotDatafeedSubscription": "<p>Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html\">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
43 "CreateSpotDatafeedSubscription": "<p>Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html\">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
4444 "CreateSubnet": "<p>Creates a subnet in an existing VPC.</p> <p>When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).</p> <important> <p>AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.</p> </important> <p>If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.</p> <p>If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.</p> <p>For more information about subnets, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
4545 "CreateTags": "<p>Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
4646 "CreateVolume": "<p>Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html\">Regions and Endpoints</a>.</p> <p>You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.</p> <p>You can create encrypted volumes with the <code>Encrypted</code> parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-volume.html\">Creating or Restoring an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
6363 "DeleteRouteTable": "<p>Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.</p>",
6464 "DeleteSecurityGroup": "<p>Deletes a security group.</p> <p>If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with <code>InvalidGroup.InUse</code> in EC2-Classic or <code>DependencyViolation</code> in EC2-VPC.</p>",
6565 "DeleteSnapshot": "<p>Deletes the specified snapshot.</p> <p>When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.</p> <p>You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-snapshot.html\">Deleting an Amazon EBS Snapshot</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
66 "DeleteSpotDatafeedSubscription": "<p>Deletes the data feed for Spot Instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html\">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
66 "DeleteSpotDatafeedSubscription": "<p>Deletes the data feed for Spot instances.</p>",
6767 "DeleteSubnet": "<p>Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.</p>",
6868 "DeleteTags": "<p>Deletes the specified set of tags from the specified set of resources. This call is designed to follow a <code>DescribeTags</code> request.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
6969 "DeleteVolume": "<p>Deletes the specified EBS volume. The volume must be in the <code>available</code> state (not attached to an instance).</p> <note> <p>The volume may remain in the <code>deleting</code> state for several minutes.</p> </note> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-deleting-volume.html\">Deleting an Amazon EBS Volume</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
108108 "DescribeSecurityGroups": "<p>Describes one or more of your security groups.</p> <p>A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html\">Amazon EC2 Security Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i> and <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
109109 "DescribeSnapshotAttribute": "<p>Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.</p> <p>For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
110110 "DescribeSnapshots": "<p>Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.</p> <p>The create volume permissions fall into the following categories:</p> <ul> <li> <i>public</i>: The owner of the snapshot granted create volume permissions for the snapshot to the <code>all</code> group. All AWS accounts have create volume permissions for these snapshots.</li> <li> <i>explicit</i>: The owner of the snapshot granted create volume permissions to a specific AWS account.</li> <li> <i>implicit</i>: An AWS account has implicit create volume permissions for all snapshots it owns.</li> </ul> <p>The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.</p> <p>If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.</p> <p>If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, <code>amazon</code> for snapshots owned by Amazon, or <code>self</code> for snapshots that you own.</p> <p>If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), <code>self</code> for snapshots for which you own or have explicit permissions, or <code>all</code> for public snapshots.</p> <p>If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. If the list of results exceeds your <code>MaxResults</code> value, then that number of results is returned along with a <code>NextToken</code> value that can be passed to a subsequent <code>DescribeSnapshots</code> request to retrieve the remaining results.</p> <p>For more information about EBS snapshots, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSSnapshots.html'>Amazon EBS Snapshots</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
111 "DescribeSpotDatafeedSubscription": "<p>Describes the data feed for Spot Instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html\">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
111 "DescribeSpotDatafeedSubscription": "<p>Describes the data feed for Spot instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html\">Spot Instance Data Feed</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
112112 "DescribeSpotFleetInstances": "<p>Describes the running instances for the specified Spot fleet.</p>",
113113 "DescribeSpotFleetRequestHistory": "<p>Describes the events for the specified Spot fleet request during the specified time.</p> <p>Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.</p>",
114114 "DescribeSpotFleetRequests": "<p>Describes your Spot fleet requests.</p>",
115 "DescribeSpotInstanceRequests": "<p>Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot Instance by examining the response. If the status of the Spot Instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p>",
116 "DescribeSpotPriceHistory": "<p>Describes the Spot Price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html\">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.</p>",
115 "DescribeSpotInstanceRequests": "<p>Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can use <code>DescribeSpotInstanceRequests</code> to find a running Spot instance by examining the response. If the status of the Spot instance is <code>fulfilled</code>, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use <a>DescribeInstances</a> with a filter to look for instances where the instance lifecycle is <code>spot</code>.</p>",
116 "DescribeSpotPriceHistory": "<p>Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html\">Spot Instance Pricing History</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.</p>",
117117 "DescribeSubnets": "<p>Describes one or more of your subnets.</p> <p>For more information about subnets, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html\">Your VPC and Subnets</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
118118 "DescribeTags": "<p>Describes one or more of the tags for your EC2 resources.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html\">Tagging Your Resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
119119 "DescribeVolumeAttribute": "<p>Describes the specified attribute of the specified volume. You can specify only one attribute at a time.</p> <p>For more information about EBS volumes, see <a href='http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumes.html'>Amazon EBS Volumes</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
167167 "ReplaceRoute": "<p>Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.</p> <p>For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
168168 "ReplaceRouteTableAssociation": "<p>Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Route_Tables.html\">Route Tables</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p> <p>You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.</p>",
169169 "ReportInstanceStatus": "<p>Submits feedback about the status of an instance. The instance must be in the <code>running</code> state. If your experience with the instance differs from the instance status returned by <a>DescribeInstanceStatus</a>, use <a>ReportInstanceStatus</a> to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.</p> <p>Use of this action does not change the value returned by <a>DescribeInstanceStatus</a>.</p>",
170 "RequestSpotFleet": "<p>Creates a Spot fleet request.</p> <p>You can submit a single request that specifies multiple instance types, each with its own instance weighting that reflects its value to your application workload. Amazon EC2 computes the bid price for each launch specification and requests Spot Instances in the Spot pool where the price per unit is the lowest. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html\">Spot Fleets</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
171 "RequestSpotInstances": "<p>Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
170 "RequestSpotFleet": "<p>Creates a Spot fleet request.</p> <p>You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.</p> <p>By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.</p> <p>Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html\">Spot Fleet Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
171 "RequestSpotInstances": "<p>Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html\">Spot Instance Requests</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
172172 "ResetImageAttribute": "<p>Resets an attribute of an AMI to its default value.</p> <note><p> The productCodes attribute can't be reset. </p></note>",
173173 "ResetInstanceAttribute": "<p>Resets an attribute of an instance to its default value. To reset the <code>kernel</code> or <code>ramdisk</code>, the instance must be in a stopped state. To reset the <code>SourceDestCheck</code>, the instance can be either running or stopped.</p> <p>The <code>SourceDestCheck</code> attribute controls whether source/destination checking is enabled. The default value is <code>true</code>, which means checking is enabled. This value must be <code>false</code> for a NAT instance to perform NAT. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html\">NAT Instances</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>",
174174 "ResetNetworkInterfaceAttribute": "<p>Resets a network interface attribute. You can specify only one attribute at a time.</p>",
269269 "base": null,
270270 "refs": {
271271 "DescribeAddressesRequest$AllocationIds": "<p>[EC2-VPC] One or more allocation IDs.</p> <p>Default: Describes all your Elastic IP addresses.</p>"
272 }
273 },
274 "AllocationStrategy": {
275 "base": null,
276 "refs": {
277 "SpotFleetRequestConfigData$AllocationStrategy": "<p>Determines how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is <code>lowestPrice</code>.</p>"
272278 }
273279 },
274280 "ArchitectureValues": {
695701 "Snapshot$Encrypted": "<p>Indicates whether the snapshot is encrypted.</p>",
696702 "SpotFleetLaunchSpecification$EbsOptimized": "<p>Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.</p> <p>Default: <code>false</code></p>",
697703 "SpotFleetMonitoring$Enabled": "<p>Enables monitoring for the instance.</p> <p>Default: <code>false</code></p>",
698 "SpotFleetRequestConfigData$TerminateInstancesWithExpiration": "<p>Indicates whether running instances should be terminated when the Spot fleet request expires.</p>",
704 "SpotFleetRequestConfigData$TerminateInstancesWithExpiration": "<p>Indicates whether running Spot instances should be terminated when the Spot fleet request expires.</p>",
699705 "StartInstancesRequest$DryRun": "<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>",
700706 "StopInstancesRequest$DryRun": "<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>",
701707 "StopInstancesRequest$Force": "<p>Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.</p> <p>Default: <code>false</code></p>",
843849 "CancelSpotInstanceRequestState": {
844850 "base": null,
845851 "refs": {
846 "CancelledSpotInstanceRequest$State": "<p>The state of the Spot Instance request.</p>"
852 "CancelledSpotInstanceRequest$State": "<p>The state of the Spot instance request.</p>"
847853 }
848854 },
849855 "CancelSpotInstanceRequestsRequest": {
857863 }
858864 },
859865 "CancelledSpotInstanceRequest": {
860 "base": "<p>Describes a request to cancel a Spot Instance.</p>",
866 "base": "<p>Describes a request to cancel a Spot instance.</p>",
861867 "refs": {
862868 "CancelledSpotInstanceRequestList$member": null
863869 }
865871 "CancelledSpotInstanceRequestList": {
866872 "base": null,
867873 "refs": {
868 "CancelSpotInstanceRequestsResult$CancelledSpotInstanceRequests": "<p>One or more Spot Instance requests.</p>"
874 "CancelSpotInstanceRequestsResult$CancelledSpotInstanceRequests": "<p>One or more Spot instance requests.</p>"
869875 }
870876 },
871877 "ClassicLinkInstance": {
12211227 "DatafeedSubscriptionState": {
12221228 "base": null,
12231229 "refs": {
1224 "SpotDatafeedSubscription$State": "<p>The state of the Spot Instance data feed subscription.</p>"
1230 "SpotDatafeedSubscription$State": "<p>The state of the Spot instance data feed subscription.</p>"
12251231 }
12261232 },
12271233 "DateTime": {
12601266 "ReservedInstancesModification$EffectiveDate": "<p>The time for the modification to become effective.</p>",
12611267 "Snapshot$StartTime": "<p>The time stamp when the snapshot was initiated.</p>",
12621268 "SpotFleetRequestConfigData$ValidFrom": "<p>The start date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). The default is to start fulfilling the request immediately.</p>",
1263 "SpotFleetRequestConfigData$ValidUntil": "<p>The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new Spot Instance requests are placed or enabled to fulfill the request.</p>",
1269 "SpotFleetRequestConfigData$ValidUntil": "<p>The end date and time of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). At this point, no new Spot instance requests are placed or enabled to fulfill the request.</p>",
12641270 "SpotInstanceRequest$ValidFrom": "<p>The start date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.</p>",
12651271 "SpotInstanceRequest$ValidUntil": "<p>The end date of the request, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.</p>",
1266 "SpotInstanceRequest$CreateTime": "<p>The date and time when the Spot Instance request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p>",
1272 "SpotInstanceRequest$CreateTime": "<p>The date and time when the Spot instance request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p>",
12671273 "SpotInstanceStatus$UpdateTime": "<p>The date and time of the most recent status update, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p>",
12681274 "SpotPrice$Timestamp": "<p>The date and time the request was created, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z).</p>",
12691275 "VgwTelemetry$LastStatusChange": "<p>The date and time of the last change in status.</p>",
22352241 "DescribeReservedInstancesOfferingsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p> </li> <li> <p><code>duration</code> - The duration of the Reserved Instance (for example, one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p> </li> <li> <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p> </li> <li> <p><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</p> </li> <li> <p><code>marketplace</code> - Set to <code>true</code> 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.</p> </li> <li> <p><code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code> Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>) </p> </li> <li> <p><code>reserved-instances-offering-id</code> - The Reserved Instances offering ID.</p> </li> <li> <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p> </li> </ul>",
22362242 "DescribeReservedInstancesRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone</code> - The Availability Zone where the Reserved Instance can be used.</p> </li> <li> <p><code>duration</code> - The duration of the Reserved Instance (one year or three years), in seconds (<code>31536000</code> | <code>94608000</code>).</p> </li> <li> <p><code>end</code> - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).</p> </li> <li> <p><code>fixed-price</code> - The purchase price of the Reserved Instance (for example, 9800.0).</p> </li> <li> <p><code>instance-type</code> - The instance type on which the Reserved Instance can be used.</p> </li> <li> <p><code>product-description</code> - The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (<code>Linux/UNIX</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Red Hat Enterprise Linux</code> | <code>Red Hat Enterprise Linux (Amazon VPC)</code> | <code>Windows</code> | <code>Windows (Amazon VPC)</code> | <code>Windows with SQL Server Standard</code> | <code>Windows with SQL Server Standard (Amazon VPC)</code> | <code>Windows with SQL Server Web</code> | <code>Windows with SQL Server Web (Amazon VPC)</code> | <code>Windows with SQL Server Enterprise</code> | <code>Windows with SQL Server Enterprise (Amazon VPC)</code>).</p> </li> <li> <p><code>reserved-instances-id</code> - The ID of the Reserved Instance.</p> </li> <li> <p><code>start</code> - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).</p> </li> <li> <p><code>state</code> - The state of the Reserved Instance (<code>payment-pending</code> | <code>active</code> | <code>payment-failed</code> | <code>retired</code>).</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>usage-price</code> - The usage price of the Reserved Instance, per hour (for example, 0.84).</p> </li> </ul>",
22372243 "DescribeRouteTablesRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>association.route-table-association-id</code> - The ID of an association ID for the route table.</p> </li> <li> <p><code>association.route-table-id</code> - The ID of the route table involved in the association.</p> </li> <li> <p><code>association.subnet-id</code> - The ID of the subnet involved in the association.</p> </li> <li> <p><code>association.main</code> - Indicates whether the route table is the main route table for the VPC.</p> </li> <li> <p><code>route-table-id</code> - The ID of the route table.</p> </li> <li> <p><code>route.destination-cidr-block</code> - The CIDR range specified in a route in the table.</p> </li> <li> <p><code>route.destination-prefix-list-id</code> - The ID (prefix) of the AWS service specified in a route in the table.</p> </li> <li> <p><code>route.gateway-id</code> - The ID of a gateway specified in a route in the table.</p> </li> <li> <p><code>route.instance-id</code> - The ID of an instance specified in a route in the table.</p> </li> <li> <p><code>route.origin</code> - Describes how the route was created. <code>CreateRouteTable</code> indicates that the route was automatically created when the route table was created; <code>CreateRoute</code> indicates that the route was manually added to the route table; <code>EnableVgwRoutePropagation</code> indicates that the route was propagated by route propagation.</p> </li> <li> <p><code>route.state</code> - The state of a route in the route table (<code>active</code> | <code>blackhole</code>). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).</p> </li> <li> <p><code>route.vpc-peering-connection-id</code> - The ID of a VPC peering connection specified in a route in the table.</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>vpc-id</code> - The ID of the VPC for the route table.</p> </li> </ul>",
2238 "DescribeSecurityGroupsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>description</code> - The description of the security group.</p> </li> <li> <p><code>egress.ip-permission.prefix-list-id</code> - The ID (prefix) of the AWS service to which the security group allows access.</p> </li> <li> <p><code>group-id</code> - The ID of the security group. </p> </li> <li> <p><code>group-name</code> - The name of the security group.</p> </li> <li> <p><code>ip-permission.cidr</code> - A CIDR range that has been granted permission.</p> </li> <li> <p><code>ip-permission.from-port</code> - The start of port range for the TCP and UDP protocols, or an ICMP type number.</p> </li> <li> <p><code>ip-permission.group-id</code> - The ID of a security group that has been granted permission.</p> </li> <li> <p><code>ip-permission.group-name</code> - The name of a security group that has been granted permission.</p> </li> <li> <p><code>ip-permission.protocol</code> - The IP protocol for the permission (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p> </li> <li> <p><code>ip-permission.to-port</code> - The end of port range for the TCP and UDP protocols, or an ICMP code.</p> </li> <li> <p><code>ip-permission.user-id</code> - The ID of an AWS account that has been granted permission.</p> </li> <li> <p><code>owner-id</code> - The AWS account ID of the owner of the security group.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the security group.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the security group.</p> </li> <li> <p><code>vpc-id</code> - The ID of the VPC specified when the security group was created.</p> </li> </ul>",
2244 "DescribeSecurityGroupsRequest$Filters": "<p>One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.</p> <ul> <li> <p><code>description</code> - The description of the security group.</p> </li> <li> <p><code>egress.ip-permission.prefix-list-id</code> - The ID (prefix) of the AWS service to which the security group allows access.</p> </li> <li> <p><code>group-id</code> - The ID of the security group. </p> </li> <li> <p><code>group-name</code> - The name of the security group.</p> </li> <li> <p><code>ip-permission.cidr</code> - A CIDR range that has been granted permission.</p> </li> <li> <p><code>ip-permission.from-port</code> - The start of port range for the TCP and UDP protocols, or an ICMP type number.</p> </li> <li> <p><code>ip-permission.group-id</code> - The ID of a security group that has been granted permission.</p> </li> <li> <p><code>ip-permission.group-name</code> - The name of a security group that has been granted permission.</p> </li> <li> <p><code>ip-permission.protocol</code> - The IP protocol for the permission (<code>tcp</code> | <code>udp</code> | <code>icmp</code> or a protocol number).</p> </li> <li> <p><code>ip-permission.to-port</code> - The end of port range for the TCP and UDP protocols, or an ICMP code.</p> </li> <li> <p><code>ip-permission.user-id</code> - The ID of an AWS account that has been granted permission.</p> </li> <li> <p><code>owner-id</code> - The AWS account ID of the owner of the security group.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the security group.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the security group.</p> </li> <li> <p><code>vpc-id</code> - The ID of the VPC specified when the security group was created.</p> </li> </ul>",
22392245 "DescribeSnapshotsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>description</code> - A description of the snapshot.</p> </li> <li> <p><code>owner-alias</code> - The AWS account alias (for example, <code>amazon</code>) that owns the snapshot.</p> </li> <li> <p><code>owner-id</code> - The ID of the AWS account that owns the snapshot.</p> </li> <li> <p><code>progress</code> - The progress of the snapshot, as a percentage (for example, 80%).</p> </li> <li> <p><code>snapshot-id</code> - The snapshot ID.</p> </li> <li> <p><code>start-time</code> - The time stamp when the snapshot was initiated.</p> </li> <li> <p><code>status</code> - The status of the snapshot (<code>pending</code> | <code>completed</code> | <code>error</code>).</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>volume-id</code> - The ID of the volume the snapshot is for.</p> </li> <li> <p><code>volume-size</code> - The size of the volume, in GiB.</p> </li> </ul>",
2240 "DescribeSpotInstanceRequestsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone-group</code> - The Availability Zone group.</p> </li> <li> <p><code>create-time</code> - The time stamp when the Spot Instance request was created.</p> </li> <li> <p><code>fault-code</code> - The fault code related to the request.</p> </li> <li> <p><code>fault-message</code> - The fault message related to the request.</p> </li> <li> <p><code>instance-id</code> - The ID of the instance that fulfilled the request.</p> </li> <li> <p><code>launch-group</code> - The Spot Instance launch group.</p> </li> <li> <p><code>launch.block-device-mapping.delete-on-termination</code> - Indicates whether the Amazon EBS volume is deleted on instance termination.</p> </li> <li> <p><code>launch.block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</p> </li> <li> <p><code>launch.block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p> </li> <li> <p><code>launch.block-device-mapping.volume-size</code> - The size of the Amazon EBS volume, in GiB.</p> </li> <li> <p><code>launch.block-device-mapping.volume-type</code> - The type of the Amazon EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</p> </li> <li> <p><code>launch.group-id</code> - The security group for the instance.</p> </li> <li> <p><code>launch.image-id</code> - The ID of the AMI.</p> </li> <li> <p><code>launch.instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p> </li> <li> <p><code>launch.kernel-id</code> - The kernel ID.</p> </li> <li> <p><code>launch.key-name</code> - The name of the key pair the instance launched with.</p> </li> <li> <p><code>launch.monitoring-enabled</code> - Whether monitoring is enabled for the Spot Instance.</p> </li> <li> <p><code>launch.ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p><code>network-interface.network-interface-id</code> - The ID of the network interface.</p> </li> <li> <p><code>network-interface.device-index</code> - The index of the device for the network interface attachment on the instance.</p> </li> <li> <p><code>network-interface.subnet-id</code> - The ID of the subnet for the instance.</p> </li> <li> <p><code>network-interface.description</code> - A description of the network interface.</p> </li> <li> <p><code>network-interface.private-ip-address</code> - The primary private IP address of the network interface.</p> </li> <li> <p><code>network-interface.delete-on-termination</code> - Indicates whether the network interface is deleted when the instance is terminated.</p> </li> <li> <p><code>network-interface.group-id</code> - The ID of the security group associated with the network interface.</p> </li> <li> <p><code>network-interface.group-name</code> - The name of the security group associated with the network interface.</p> </li> <li> <p><code>network-interface.addresses.primary</code> - Indicates whether the IP address is the primary private IP address.</p> </li> <li> <p><code>product-description</code> - The product description associated with the instance (<code>Linux/UNIX</code> | <code>Windows</code>).</p> </li> <li> <p><code>spot-instance-request-id</code> - The Spot Instance request ID.</p> </li> <li> <p><code>spot-price</code> - The maximum hourly price for any Spot Instance launched to fulfill the request.</p> </li> <li> <p><code>state</code> - The state of the Spot Instance request (<code>open</code> | <code>active</code> | <code>closed</code> | <code>cancelled</code> | <code>failed</code>). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html\">Spot Bid Status</a> in the Amazon Elastic Compute Cloud User Guide.</p> </li> <li> <p><code>status-code</code> - The short code describing the most recent evaluation of your Spot Instance request.</p> </li> <li> <p><code>status-message</code> - The message explaining the status of the Spot Instance request.</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>type</code> - The type of Spot Instance request (<code>one-time</code> | <code>persistent</code>).</p> </li> <li> <p><code>launched-availability-zone</code> - The Availability Zone in which the bid is launched.</p> </li> <li> <p><code>valid-from</code> - The start date of the request.</p> </li> <li> <p><code>valid-until</code> - The end date of the request.</p> </li> </ul>",
2241 "DescribeSpotPriceHistoryRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone</code> - The Availability Zone for which prices should be returned.</p> </li> <li> <p><code>instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p> </li> <li> <p><code>product-description</code> - The product description for the Spot Price (<code>Linux/UNIX</code> | <code>SUSE Linux</code> | <code>Windows</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Windows (Amazon VPC)</code>).</p> </li> <li> <p><code>spot-price</code> - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).</p> </li> <li> <p><code>timestamp</code> - The timestamp of the Spot Price history, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.</p> </li> </ul>",
2246 "DescribeSpotInstanceRequestsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone-group</code> - The Availability Zone group.</p> </li> <li> <p><code>create-time</code> - The time stamp when the Spot instance request was created.</p> </li> <li> <p><code>fault-code</code> - The fault code related to the request.</p> </li> <li> <p><code>fault-message</code> - The fault message related to the request.</p> </li> <li> <p><code>instance-id</code> - The ID of the instance that fulfilled the request.</p> </li> <li> <p><code>launch-group</code> - The Spot instance launch group.</p> </li> <li> <p><code>launch.block-device-mapping.delete-on-termination</code> - Indicates whether the Amazon EBS volume is deleted on instance termination.</p> </li> <li> <p><code>launch.block-device-mapping.device-name</code> - The device name for the Amazon EBS volume (for example, <code>/dev/sdh</code>).</p> </li> <li> <p><code>launch.block-device-mapping.snapshot-id</code> - The ID of the snapshot used for the Amazon EBS volume.</p> </li> <li> <p><code>launch.block-device-mapping.volume-size</code> - The size of the Amazon EBS volume, in GiB.</p> </li> <li> <p><code>launch.block-device-mapping.volume-type</code> - The type of the Amazon EBS volume (<code>gp2</code> | <code>standard</code> | <code>io1</code>).</p> </li> <li> <p><code>launch.group-id</code> - The security group for the instance.</p> </li> <li> <p><code>launch.image-id</code> - The ID of the AMI.</p> </li> <li> <p><code>launch.instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p> </li> <li> <p><code>launch.kernel-id</code> - The kernel ID.</p> </li> <li> <p><code>launch.key-name</code> - The name of the key pair the instance launched with.</p> </li> <li> <p><code>launch.monitoring-enabled</code> - Whether monitoring is enabled for the Spot instance.</p> </li> <li> <p><code>launch.ramdisk-id</code> - The RAM disk ID.</p> </li> <li> <p><code>network-interface.network-interface-id</code> - The ID of the network interface.</p> </li> <li> <p><code>network-interface.device-index</code> - The index of the device for the network interface attachment on the instance.</p> </li> <li> <p><code>network-interface.subnet-id</code> - The ID of the subnet for the instance.</p> </li> <li> <p><code>network-interface.description</code> - A description of the network interface.</p> </li> <li> <p><code>network-interface.private-ip-address</code> - The primary private IP address of the network interface.</p> </li> <li> <p><code>network-interface.delete-on-termination</code> - Indicates whether the network interface is deleted when the instance is terminated.</p> </li> <li> <p><code>network-interface.group-id</code> - The ID of the security group associated with the network interface.</p> </li> <li> <p><code>network-interface.group-name</code> - The name of the security group associated with the network interface.</p> </li> <li> <p><code>network-interface.addresses.primary</code> - Indicates whether the IP address is the primary private IP address.</p> </li> <li> <p><code>product-description</code> - The product description associated with the instance (<code>Linux/UNIX</code> | <code>Windows</code>).</p> </li> <li> <p><code>spot-instance-request-id</code> - The Spot instance request ID.</p> </li> <li> <p><code>spot-price</code> - The maximum hourly price for any Spot instance launched to fulfill the request.</p> </li> <li> <p><code>state</code> - The state of the Spot instance request (<code>open</code> | <code>active</code> | <code>closed</code> | <code>cancelled</code> | <code>failed</code>). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html\">Spot Bid Status</a> in the Amazon Elastic Compute Cloud User Guide.</p> </li> <li> <p><code>status-code</code> - The short code describing the most recent evaluation of your Spot instance request.</p> </li> <li> <p><code>status-message</code> - The message explaining the status of the Spot instance request.</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>type</code> - The type of Spot instance request (<code>one-time</code> | <code>persistent</code>).</p> </li> <li> <p><code>launched-availability-zone</code> - The Availability Zone in which the bid is launched.</p> </li> <li> <p><code>valid-from</code> - The start date of the request.</p> </li> <li> <p><code>valid-until</code> - The end date of the request.</p> </li> </ul>",
2247 "DescribeSpotPriceHistoryRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availability-zone</code> - The Availability Zone for which prices should be returned.</p> </li> <li> <p><code>instance-type</code> - The type of instance (for example, <code>m1.small</code>).</p> </li> <li> <p><code>product-description</code> - The product description for the Spot price (<code>Linux/UNIX</code> | <code>SUSE Linux</code> | <code>Windows</code> | <code>Linux/UNIX (Amazon VPC)</code> | <code>SUSE Linux (Amazon VPC)</code> | <code>Windows (Amazon VPC)</code>).</p> </li> <li> <p><code>spot-price</code> - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).</p> </li> <li> <p><code>timestamp</code> - The timestamp of the Spot price history, in UTC format (for example, <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.</p> </li> </ul>",
22422248 "DescribeSubnetsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>availabilityZone</code> - The Availability Zone for the subnet. You can also use <code>availability-zone</code> as the filter name.</p> </li> <li> <p><code>available-ip-address-count</code> - The number of IP addresses in the subnet that are available.</p> </li> <li> <p><code>cidrBlock</code> - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use <code>cidr</code> or <code>cidr-block</code> as the filter names.</p> </li> <li> <p><code>defaultForAz</code> - Indicates whether this is the default subnet for the Availability Zone. You can also use <code>default-for-az</code> as the filter name.</p> </li> <li> <p><code>state</code> - The state of the subnet (<code>pending</code> | <code>available</code>).</p> </li> <li> <p><code>subnet-id</code> - The ID of the subnet.</p> </li> <li> <p><code>tag</code>:<i>key</i>=<i>value</i> - The key/value combination of a tag assigned to the resource.</p> </li> <li> <p><code>tag-key</code> - The key of a tag assigned to the resource. This filter is independent of the <code>tag-value</code> filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned 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). If you want to list only resources where Purpose is X, see the <code>tag</code>:<i>key</i>=<i>value</i> filter.</p> </li> <li> <p><code>tag-value</code> - The value of a tag assigned to the resource. This filter is independent of the <code>tag-key</code> filter.</p> </li> <li> <p><code>vpc-id</code> - The ID of the VPC for the subnet.</p> </li> </ul>",
22432249 "DescribeTagsRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>key</code> - The tag key.</p> </li> <li> <p><code>resource-id</code> - The resource ID.</p> </li> <li> <p><code>resource-type</code> - The resource type (<code>customer-gateway</code> | <code>dhcp-options</code> | <code>image</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-interface</code> | <code>reserved-instances</code> | <code>route-table</code> | <code>security-group</code> | <code>snapshot</code> | <code>spot-instances-request</code> | <code>subnet</code> | <code>volume</code> | <code>vpc</code> | <code>vpn-connection</code> | <code>vpn-gateway</code>).</p> </li> <li> <p><code>value</code> - The tag value.</p> </li> </ul>",
22442250 "DescribeVolumeStatusRequest$Filters": "<p>One or more filters.</p> <ul> <li> <p><code>action.code</code> - The action code for the event (for example, <code>enable-volume-io</code>).</p> </li> <li> <p><code>action.description</code> - A description of the action.</p> </li> <li> <p><code>action.event-id</code> - The event ID associated with the action.</p> </li> <li> <p><code>availability-zone</code> - The Availability Zone of the instance.</p> </li> <li> <p><code>event.description</code> - A description of the event.</p> </li> <li> <p><code>event.event-id</code> - The event ID.</p> </li> <li> <p><code>event.event-type</code> - The event type (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>io-performance:degraded</code> | <code>io-performance:severely-degraded</code> | <code>io-performance:stalled</code>).</p> </li> <li> <p><code>event.not-after</code> - The latest end time for the event.</p> </li> <li> <p><code>event.not-before</code> - The earliest start time for the event.</p> </li> <li> <p><code>volume-status.details-name</code> - The cause for <code>volume-status.status</code> (<code>io-enabled</code> | <code>io-performance</code>).</p> </li> <li> <p><code>volume-status.details-status</code> - The status of <code>volume-status.details-name</code> (for <code>io-enabled</code>: <code>passed</code> | <code>failed</code>; for <code>io-performance</code>: <code>normal</code> | <code>degraded</code> | <code>severely-degraded</code> | <code>stalled</code>).</p> </li> <li> <p><code>volume-status.status</code> - The status of the volume (<code>ok</code> | <code>impaired</code> | <code>warning</code> | <code>insufficient-data</code>).</p> </li> </ul>",
28522858 "PricingDetail$Count": "<p>The number of instances available for the price.</p>",
28532859 "PurchaseReservedInstancesOfferingRequest$InstanceCount": "<p>The number of Reserved Instances to purchase.</p>",
28542860 "ReplaceNetworkAclEntryRequest$RuleNumber": "<p>The rule number of the entry to replace.</p>",
2855 "RequestSpotInstancesRequest$InstanceCount": "<p>The maximum number of Spot Instances to launch.</p> <p>Default: 1</p>",
2861 "RequestSpotInstancesRequest$InstanceCount": "<p>The maximum number of Spot instances to launch.</p> <p>Default: 1</p>",
28562862 "ReservedInstances$InstanceCount": "<p>The number of Reserved Instances purchased.</p>",
28572863 "ReservedInstancesConfiguration$InstanceCount": "<p>The number of modified Reserved Instances.</p>",
28582864 "RevokeSecurityGroupEgressRequest$FromPort": "<p>The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use <code>-1</code> to specify all ICMP types.</p>",
29752981 "LaunchSpecsList": {
29762982 "base": null,
29772983 "refs": {
2978 "SpotFleetRequestConfigData$LaunchSpecifications": "<p>Information about the launch specifications for the instances.</p>"
2984 "SpotFleetRequestConfigData$LaunchSpecifications": "<p>Information about the launch specifications for the Spot fleet request.</p>"
29792985 }
29802986 },
29812987 "ListingState": {
34493455 "DescribeReservedInstancesOfferingsRequest$ProductDescription": "<p>The Reserved Instance product platform description. Instances that include <code>(Amazon VPC)</code> in the description are for use with Amazon VPC.</p>",
34503456 "ReservedInstances$ProductDescription": "<p>The Reserved Instance product platform description.</p>",
34513457 "ReservedInstancesOffering$ProductDescription": "<p>The Reserved Instance product platform description.</p>",
3452 "SpotInstanceRequest$ProductDescription": "<p>The product description associated with the Spot Instance.</p>",
3458 "SpotInstanceRequest$ProductDescription": "<p>The product description associated with the Spot instance.</p>",
34533459 "SpotPrice$ProductDescription": "<p>A general description of the AMI.</p>"
34543460 }
34553461 },
39593965 }
39603966 },
39613967 "SpotDatafeedSubscription": {
3962 "base": "<p>Describes the data feed for a Spot Instance.</p>",
3963 "refs": {
3964 "CreateSpotDatafeedSubscriptionResult$SpotDatafeedSubscription": "<p>The Spot Instance data feed subscription.</p>",
3965 "DescribeSpotDatafeedSubscriptionResult$SpotDatafeedSubscription": "<p>The Spot Instance data feed subscription.</p>"
3968 "base": "<p>Describes the data feed for a Spot instance.</p>",
3969 "refs": {
3970 "CreateSpotDatafeedSubscriptionResult$SpotDatafeedSubscription": "<p>The Spot instance data feed subscription.</p>",
3971 "DescribeSpotDatafeedSubscriptionResult$SpotDatafeedSubscription": "<p>The Spot instance data feed subscription.</p>"
39663972 }
39673973 },
39683974 "SpotFleetLaunchSpecification": {
3969 "base": "<p>Describes the launch specification for one or more Spot Instances.</p>",
3975 "base": "<p>Describes the launch specification for one or more Spot instances.</p>",
39703976 "refs": {
39713977 "LaunchSpecsList$member": null
39723978 }
39974003 }
39984004 },
39994005 "SpotInstanceRequest": {
4000 "base": "<p>Describe a Spot Instance request.</p>",
4006 "base": "<p>Describe a Spot instance request.</p>",
40014007 "refs": {
40024008 "SpotInstanceRequestList$member": null
40034009 }
40054011 "SpotInstanceRequestIdList": {
40064012 "base": null,
40074013 "refs": {
4008 "CancelSpotInstanceRequestsRequest$SpotInstanceRequestIds": "<p>One or more Spot Instance request IDs.</p>",
4009 "DescribeSpotInstanceRequestsRequest$SpotInstanceRequestIds": "<p>One or more Spot Instance request IDs.</p>"
4014 "CancelSpotInstanceRequestsRequest$SpotInstanceRequestIds": "<p>One or more Spot instance request IDs.</p>",
4015 "DescribeSpotInstanceRequestsRequest$SpotInstanceRequestIds": "<p>One or more Spot instance request IDs.</p>"
40104016 }
40114017 },
40124018 "SpotInstanceRequestList": {
40134019 "base": null,
40144020 "refs": {
4015 "DescribeSpotInstanceRequestsResult$SpotInstanceRequests": "<p>One or more Spot Instance requests.</p>",
4016 "RequestSpotInstancesResult$SpotInstanceRequests": "<p>One or more Spot Instance requests.</p>"
4021 "DescribeSpotInstanceRequestsResult$SpotInstanceRequests": "<p>One or more Spot instance requests.</p>",
4022 "RequestSpotInstancesResult$SpotInstanceRequests": "<p>One or more Spot instance requests.</p>"
40174023 }
40184024 },
40194025 "SpotInstanceState": {
40204026 "base": null,
40214027 "refs": {
4022 "SpotInstanceRequest$State": "<p>The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html\">Spot Bid Status</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
4028 "SpotInstanceRequest$State": "<p>The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html\">Spot Bid Status</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
40234029 }
40244030 },
40254031 "SpotInstanceStateFault": {
4026 "base": "<p>Describes a Spot Instance state change.</p>",
4027 "refs": {
4028 "SpotDatafeedSubscription$Fault": "<p>The fault codes for the Spot Instance request, if any.</p>",
4029 "SpotInstanceRequest$Fault": "<p>The fault codes for the Spot Instance request, if any.</p>"
4032 "base": "<p>Describes a Spot instance state change.</p>",
4033 "refs": {
4034 "SpotDatafeedSubscription$Fault": "<p>The fault codes for the Spot instance request, if any.</p>",
4035 "SpotInstanceRequest$Fault": "<p>The fault codes for the Spot instance request, if any.</p>"
40304036 }
40314037 },
40324038 "SpotInstanceStatus": {
4033 "base": "<p>Describes the status of a Spot Instance request.</p>",
4034 "refs": {
4035 "SpotInstanceRequest$Status": "<p>The status code and status message describing the Spot Instance request.</p>"
4039 "base": "<p>Describes the status of a Spot instance request.</p>",
4040 "refs": {
4041 "SpotInstanceRequest$Status": "<p>The status code and status message describing the Spot instance request.</p>"
40364042 }
40374043 },
40384044 "SpotInstanceType": {
40394045 "base": null,
40404046 "refs": {
4041 "RequestSpotInstancesRequest$Type": "<p>The Spot Instance request type.</p> <p>Default: <code>one-time</code></p>",
4042 "SpotInstanceRequest$Type": "<p>The Spot Instance request type.</p>"
4047 "RequestSpotInstancesRequest$Type": "<p>The Spot instance request type.</p> <p>Default: <code>one-time</code></p>",
4048 "SpotInstanceRequest$Type": "<p>The Spot instance request type.</p>"
40434049 }
40444050 },
40454051 "SpotPlacement": {
4046 "base": "<p>Describes Spot Instance placement.</p>",
4052 "base": "<p>Describes Spot instance placement.</p>",
40474053 "refs": {
40484054 "LaunchSpecification$Placement": "<p>The placement information for the instance.</p>",
40494055 "SpotFleetLaunchSpecification$Placement": "<p>The placement information.</p>",
40514057 }
40524058 },
40534059 "SpotPrice": {
4054 "base": "<p>Describes the maximum hourly price (bid) for any Spot Instance launched to fulfill the request.</p>",
4060 "base": "<p>Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.</p>",
40554061 "refs": {
40564062 "SpotPriceHistoryList$member": null
40574063 }
40594065 "SpotPriceHistoryList": {
40604066 "base": null,
40614067 "refs": {
4062 "DescribeSpotPriceHistoryResult$SpotPriceHistory": "<p>The historical Spot Prices.</p>"
4068 "DescribeSpotPriceHistoryResult$SpotPriceHistory": "<p>The historical Spot prices.</p>"
40634069 }
40644070 },
40654071 "StartInstancesRequest": {
41294135 "AccountAttributeValue$AttributeValue": "<p>The value of the attribute.</p>",
41304136 "ActiveInstance$InstanceType": "<p>The instance type.</p>",
41314137 "ActiveInstance$InstanceId": "<p>The ID of the instance.</p>",
4132 "ActiveInstance$SpotInstanceRequestId": "<p>The ID of the Spot Instance request.</p>",
4138 "ActiveInstance$SpotInstanceRequestId": "<p>The ID of the Spot instance request.</p>",
41334139 "Address$InstanceId": "<p>The ID of the instance that the address is associated with (if any).</p>",
41344140 "Address$PublicIp": "<p>The Elastic IP address.</p>",
41354141 "Address$AllocationId": "<p>The ID representing the allocation of the address for use with EC2-VPC.</p>",
42024208 "CancelSpotFleetRequestsError$Message": "<p>The description for the error code.</p>",
42034209 "CancelSpotFleetRequestsErrorItem$SpotFleetRequestId": "<p>The ID of the Spot fleet request.</p>",
42044210 "CancelSpotFleetRequestsSuccessItem$SpotFleetRequestId": "<p>The ID of the Spot fleet request.</p>",
4205 "CancelledSpotInstanceRequest$SpotInstanceRequestId": "<p>The ID of the Spot Instance request.</p>",
4211 "CancelledSpotInstanceRequest$SpotInstanceRequestId": "<p>The ID of the Spot instance request.</p>",
42064212 "ClassicLinkInstance$InstanceId": "<p>The ID of the instance.</p>",
42074213 "ClassicLinkInstance$VpcId": "<p>The ID of the VPC.</p>",
42084214 "ClientData$Comment": "<p>A user-defined comment about the disk upload.</p>",
42614267 "CreateSecurityGroupResult$GroupId": "<p>The ID of the security group.</p>",
42624268 "CreateSnapshotRequest$VolumeId": "<p>The ID of the EBS volume.</p>",
42634269 "CreateSnapshotRequest$Description": "<p>A description for the snapshot.</p>",
4264 "CreateSpotDatafeedSubscriptionRequest$Bucket": "<p>The Amazon S3 bucket in which to store the Spot Instance data feed.</p>",
4270 "CreateSpotDatafeedSubscriptionRequest$Bucket": "<p>The Amazon S3 bucket in which to store the Spot instance data feed.</p>",
42654271 "CreateSpotDatafeedSubscriptionRequest$Prefix": "<p>A prefix for the data feed file names.</p>",
42664272 "CreateSubnetRequest$VpcId": "<p>The ID of the VPC.</p>",
42674273 "CreateSubnetRequest$CidrBlock": "<p>The network range for the subnet, in CIDR notation. For example, <code>10.0.0.0/24</code>.</p>",
44044410 "EnableVolumeIORequest$VolumeId": "<p>The ID of the volume.</p>",
44054411 "EnableVpcClassicLinkRequest$VpcId": "<p>The ID of the VPC.</p>",
44064412 "EventInformation$InstanceId": "<p>The ID of the instance. This information is available only for <code>instanceChange</code> events.</p>",
4407 "EventInformation$EventSubType": "<p>The event.</p> <p>The following are the <code>error</code> events.</p> <ul> <li> <p><code>iamFleetRoleInvalid</code> - Spot fleet did not have the required permissions either to launch or terminate an instance.</p> </li> <li> <p><code>spotFleetRequestConfigurationInvalid</code> - The configuration is not valid. For more information, see the description.</p> </li> <li> <p><code>spotInstanceCountLimitExceeded</code> - You've reached the limit on the number of Spot Instances that you can launch.</p> </li> </ul> <p>The following are the <code>fleetRequestChange</code> events.</p> <ul> <li> <p><code>active</code> - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot Instances.</p> </li> <li> <p><code>cancelled</code> - The Spot fleet is canceled and has no running Spot Instances. The Spot fleet will be deleted two days after its instances were terminated.</p> </li> <li> <p><code>cancelled_running</code> - The Spot fleet is canceled and will not launch additional Spot Instances, but its existing Spot Instances will continue to run until they are interrupted or terminated.</p> </li> <li> <p><code>cancelled_terminating</code> - The Spot fleet is canceled and its Spot Instances are terminating.</p> </li> <li> <p><code>expired</code> - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with <code>TerminateInstancesWithExpiration</code> set.</p> </li> <li> <p><code>price_update</code> - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.</p> </li> <li> <p><code>submitted</code> - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot Instances.</p> </li> </ul> <p>The following are the <code>instanceChange</code> events.</p> <ul> <li> <p><code>launched</code> - A bid was fulfilled and a new instance was launched.</p> </li> <li> <p><code>terminated</code> - An instance was terminated by the user.</p> </li> </ul>",
4413 "EventInformation$EventSubType": "<p>The event.</p> <p>The following are the <code>error</code> events.</p> <ul> <li> <p><code>iamFleetRoleInvalid</code> - Spot fleet did not have the required permissions either to launch or terminate an instance.</p> </li> <li> <p><code>spotFleetRequestConfigurationInvalid</code> - The configuration is not valid. For more information, see the description.</p> </li> <li> <p><code>spotInstanceCountLimitExceeded</code> - You've reached the limit on the number of Spot instances that you can launch.</p> </li> </ul> <p>The following are the <code>fleetRequestChange</code> events.</p> <ul> <li> <p><code>active</code> - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.</p> </li> <li> <p><code>cancelled</code> - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.</p> </li> <li> <p><code>cancelled_running</code> - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.</p> </li> <li> <p><code>cancelled_terminating</code> - The Spot fleet is canceled and its Spot instances are terminating.</p> </li> <li> <p><code>expired</code> - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with <code>TerminateInstancesWithExpiration</code> set.</p> </li> <li> <p><code>price_update</code> - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.</p> </li> <li> <p><code>submitted</code> - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.</p> </li> </ul> <p>The following are the <code>instanceChange</code> events.</p> <ul> <li> <p><code>launched</code> - A bid was fulfilled and a new instance was launched.</p> </li> <li> <p><code>terminated</code> - An instance was terminated by the user.</p> </li> </ul>",
44084414 "EventInformation$EventDescription": "<p>The description of the event.</p>",
44094415 "ExecutableByStringList$member": null,
44104416 "ExportTask$ExportTaskId": "<p>The ID of the export task.</p>",
46664672 "ReplaceRouteTableAssociationResult$NewAssociationId": "<p>The ID of the new association.</p>",
46674673 "ReportInstanceStatusRequest$Description": "<p>Descriptive text about the health state of your instance.</p>",
46684674 "RequestSpotFleetResponse$SpotFleetRequestId": "<p>The ID of the Spot fleet request.</p>",
4669 "RequestSpotInstancesRequest$SpotPrice": "<p>The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.</p>",
4675 "RequestSpotInstancesRequest$SpotPrice": "<p>The maximum hourly price (bid) for any Spot instance launched to fulfill the request.</p>",
46704676 "RequestSpotInstancesRequest$ClientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html\">How to Ensure Idempotency</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
4671 "RequestSpotInstancesRequest$LaunchGroup": "<p>The instance launch group. Launch groups are Spot Instances that launch together and terminate together.</p> <p>Default: Instances are launched and terminated individually</p>",
4672 "RequestSpotInstancesRequest$AvailabilityZoneGroup": "<p>The user-specified name for a logical grouping of bids.</p> <p>When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.</p> <p>If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.</p> <p>Default: Instances are launched in any available Availability Zone.</p>",
4677 "RequestSpotInstancesRequest$LaunchGroup": "<p>The instance launch group. Launch groups are Spot instances that launch together and terminate together.</p> <p>Default: Instances are launched and terminated individually</p>",
4678 "RequestSpotInstancesRequest$AvailabilityZoneGroup": "<p>The user-specified name for a logical grouping of bids.</p> <p>When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.</p> <p>If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.</p> <p>Default: Instances are launched in any available Availability Zone.</p>",
46734679 "Reservation$ReservationId": "<p>The ID of the reservation.</p>",
46744680 "Reservation$OwnerId": "<p>The ID of the AWS account that owns the reservation.</p>",
46754681 "Reservation$RequesterId": "<p>The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).</p>",
47444750 "SecurityGroup$VpcId": "<p>[EC2-VPC] The ID of the VPC for the security group.</p>",
47454751 "SecurityGroupIdStringList$member": null,
47464752 "SecurityGroupStringList$member": null,
4747 "Snapshot$SnapshotId": "<p>The ID of the snapshot.</p>",
4748 "Snapshot$VolumeId": "<p>The ID of the volume.</p>",
4753 "Snapshot$SnapshotId": "<p>The ID of the snapshot. Each snapshot receives a unique identifier when it is created.</p>",
4754 "Snapshot$VolumeId": "<p>The ID of the volume that was used to create the snapshot.</p>",
4755 "Snapshot$StateMessage": "<p>Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the <a>DescribeSnapshots</a> API operation.</p>",
47494756 "Snapshot$Progress": "<p>The progress of the snapshot, as a percentage.</p>",
47504757 "Snapshot$OwnerId": "<p>The AWS account ID of the EBS snapshot owner.</p>",
47514758 "Snapshot$Description": "<p>The description for the snapshot.</p>",
47524759 "Snapshot$OwnerAlias": "<p>The AWS account alias (for example, <code>amazon</code>, <code>self</code>) or AWS account ID that owns the snapshot.</p>",
47534760 "Snapshot$KmsKeyId": "<p>The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.</p>",
4761 "Snapshot$DataEncryptionKeyId": "<p>The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the <a>DescribeSnapshots</a> API operation.</p>",
47544762 "SnapshotDetail$Description": "<p>A description for the snapshot.</p>",
47554763 "SnapshotDetail$Format": "<p>The format of the disk image from which the snapshot is created.</p>",
47564764 "SnapshotDetail$Url": "<p>The URL used to access the disk image.</p>",
47714779 "SnapshotTaskDetail$StatusMessage": "<p>A detailed status message for the import snapshot task.</p>",
47724780 "SnapshotTaskDetail$Status": "<p>A brief status for the import snapshot task.</p>",
47734781 "SpotDatafeedSubscription$OwnerId": "<p>The AWS account ID of the account.</p>",
4774 "SpotDatafeedSubscription$Bucket": "<p>The Amazon S3 bucket where the Spot Instance data feed is located.</p>",
4782 "SpotDatafeedSubscription$Bucket": "<p>The Amazon S3 bucket where the Spot instance data feed is located.</p>",
47754783 "SpotDatafeedSubscription$Prefix": "<p>The prefix that is prepended to data feed files.</p>",
47764784 "SpotFleetLaunchSpecification$ImageId": "<p>The ID of the AMI.</p>",
47774785 "SpotFleetLaunchSpecification$KeyName": "<p>The name of the key pair.</p>",
47844792 "SpotFleetRequestConfig$SpotFleetRequestId": "<p>The ID of the Spot fleet request.</p>",
47854793 "SpotFleetRequestConfigData$ClientToken": "<p>A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Ensuring Idempotency</a>.</p>",
47864794 "SpotFleetRequestConfigData$SpotPrice": "<p>The bid price per unit hour.</p>",
4787 "SpotFleetRequestConfigData$IamFleetRole": "<p>Grants the Spot fleet service permission to terminate instances on your behalf when you cancel a Spot fleet request using <a>CancelSpotFleetRequests</a> or when the Spot fleet request expires, if you set <code>terminateInstancesWithExpiration</code>.</p>",
4788 "SpotInstanceRequest$SpotInstanceRequestId": "<p>The ID of the Spot Instance request.</p>",
4789 "SpotInstanceRequest$SpotPrice": "<p>The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.</p>",
4790 "SpotInstanceRequest$LaunchGroup": "<p>The instance launch group. Launch groups are Spot Instances that launch together and terminate together.</p>",
4791 "SpotInstanceRequest$AvailabilityZoneGroup": "<p>The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.</p>",
4792 "SpotInstanceRequest$InstanceId": "<p>The instance ID, if an instance has been launched to fulfill the Spot Instance request.</p>",
4795 "SpotFleetRequestConfigData$IamFleetRole": "<p>Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using <a>CancelSpotFleetRequests</a> or when the Spot fleet request expires, if you set <code>terminateInstancesWithExpiration</code>.</p>",
4796 "SpotInstanceRequest$SpotInstanceRequestId": "<p>The ID of the Spot instance request.</p>",
4797 "SpotInstanceRequest$SpotPrice": "<p>The maximum hourly price (bid) for any Spot instance launched to fulfill the request.</p>",
4798 "SpotInstanceRequest$LaunchGroup": "<p>The instance launch group. Launch groups are Spot instances that launch together and terminate together.</p>",
4799 "SpotInstanceRequest$AvailabilityZoneGroup": "<p>The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.</p>",
4800 "SpotInstanceRequest$InstanceId": "<p>The instance ID, if an instance has been launched to fulfill the Spot instance request.</p>",
47934801 "SpotInstanceRequest$LaunchedAvailabilityZone": "<p>The Availability Zone in which the bid is launched.</p>",
47944802 "SpotInstanceRequestIdList$member": null,
4795 "SpotInstanceStateFault$Code": "<p>The reason code for the Spot Instance state change.</p>",
4796 "SpotInstanceStateFault$Message": "<p>The message for the Spot Instance state change.</p>",
4803 "SpotInstanceStateFault$Code": "<p>The reason code for the Spot instance state change.</p>",
4804 "SpotInstanceStateFault$Message": "<p>The message for the Spot instance state change.</p>",
47974805 "SpotInstanceStatus$Code": "<p>The status code.</p>",
47984806 "SpotInstanceStatus$Message": "<p>The description for the status code.</p>",
47994807 "SpotPlacement$AvailabilityZone": "<p>The Availability Zone.</p>",
48004808 "SpotPlacement$GroupName": "<p>The name of the placement group (for cluster instances).</p>",
4801 "SpotPrice$SpotPrice": "<p>The maximum price (bid) that you are willing to pay for a Spot Instance.</p>",
4809 "SpotPrice$SpotPrice": "<p>The maximum price (bid) that you are willing to pay for a Spot instance.</p>",
48024810 "SpotPrice$AvailabilityZone": "<p>The Availability Zone.</p>",
48034811 "StartInstancesRequest$AdditionalInfo": "<p>Reserved.</p>",
48044812 "StateReason$Code": "<p>The reason code for the state change.</p>",
+19
-33
apis/elasticfilesystem/2015-02-01/api-2.json less more
309309 "shape":"FileSystemNotFound",
310310 "error":{"httpStatusCode":404},
311311 "exception":true
312 },
313 {
314 "shape":"MountTargetNotFound",
315 "error":{"httpStatusCode":404},
316 "exception":true
312317 }
313318 ]
314319 },
382387 }
383388 },
384389 "shapes":{
385 "AwsAccountId":{
386 "type":"string",
387 "pattern":"[0-9]{12}"
388 },
390 "AwsAccountId":{"type":"string"},
389391 "BadRequest":{
390392 "type":"structure",
391393 "required":["ErrorCode"],
536538 },
537539 "DescribeMountTargetsRequest":{
538540 "type":"structure",
539 "required":["FileSystemId"],
540541 "members":{
541542 "MaxItems":{
542543 "shape":"MaxItems",
552553 "shape":"FileSystemId",
553554 "location":"querystring",
554555 "locationName":"FileSystemId"
556 },
557 "MountTargetId":{
558 "shape":"MountTargetId",
559 "location":"querystring",
560 "locationName":"MountTargetId"
555561 }
556562 }
557563 },
638644 "type":"list",
639645 "member":{"shape":"FileSystemDescription"}
640646 },
641 "FileSystemId":{
642 "type":"string",
643 "pattern":"fs-[0-9a-f]{8}"
644 },
647 "FileSystemId":{"type":"string"},
645648 "FileSystemInUse":{
646649 "type":"structure",
647650 "required":["ErrorCode"],
714717 "error":{"httpStatusCode":500},
715718 "exception":true
716719 },
717 "IpAddress":{
718 "type":"string",
719 "pattern":"[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}"
720 },
720 "IpAddress":{"type":"string"},
721721 "IpAddressInUse":{
722722 "type":"structure",
723723 "required":["ErrorCode"],
790790 "type":"list",
791791 "member":{"shape":"MountTargetDescription"}
792792 },
793 "MountTargetId":{
794 "type":"string",
795 "pattern":"fsmt-[0-9a-f]{8}"
796 },
793 "MountTargetId":{"type":"string"},
797794 "MountTargetNotFound":{
798795 "type":"structure",
799796 "required":["ErrorCode"],
804801 "error":{"httpStatusCode":404},
805802 "exception":true
806803 },
807 "NetworkInterfaceId":{
808 "type":"string",
809 "pattern":"eni-[0-9a-f]{8}"
810 },
804 "NetworkInterfaceId":{"type":"string"},
811805 "NetworkInterfaceLimitExceeded":{
812806 "type":"structure",
813807 "required":["ErrorCode"],
828822 "error":{"httpStatusCode":409},
829823 "exception":true
830824 },
831 "SecurityGroup":{
832 "type":"string",
833 "pattern":"sg-[0-9a-f]{8}"
834 },
825 "SecurityGroup":{"type":"string"},
835826 "SecurityGroupLimitExceeded":{
836827 "type":"structure",
837828 "required":["ErrorCode"],
857848 "member":{"shape":"SecurityGroup"},
858849 "max":5
859850 },
860 "SubnetId":{
861 "type":"string",
862 "pattern":"subnet-[0-9a-f]{8}"
863 },
851 "SubnetId":{"type":"string"},
864852 "SubnetNotFound":{
865853 "type":"structure",
866854 "required":["ErrorCode"],
885873 "TagKey":{
886874 "type":"string",
887875 "min":1,
888 "max":128,
889 "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
876 "max":128
890877 },
891878 "TagKeys":{
892879 "type":"list",
894881 },
895882 "TagValue":{
896883 "type":"string",
897 "max":256,
898 "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
884 "max":256
899885 },
900886 "Tags":{
901887 "type":"list",
+6
-5
apis/elasticfilesystem/2015-02-01/docs-2.json less more
11 "version": "2.0",
22 "operations": {
33 "CreateFileSystem": "<p> Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following: </p> <ul> <li>Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state \"creating\". </li> <li> Returns with the description of the created file system. </li> </ul> <p>Otherwise, this operation returns a <code>FileSystemAlreadyExists</code> error with the ID of the existing file system.</p> <note>For basic use cases, you can use a randomly generated UUID for the creation token.</note> <p> The idempotent operation allows you to retry a <code>CreateFileSystem</code> call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the <code>FileSystemAlreadyExists</code> error. </p> <note>The <code>CreateFileSystem</code> call returns while the file system's lifecycle state is still \"creating\". You can check the file system creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the file system state.</note> <p> After the file system is fully created, Amazon EFS sets its lifecycle state to \"available\", at which point you can create one or more mount targets for the file system (<a>CreateMountTarget</a>) in your VPC. You mount your Amazon EFS file system on an EC2 instances in your VPC via the mount target. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a> </p> <p> This operation requires permission for the <code>elasticfilesystem:CreateFileSystem</code> action. </p>",
4 "CreateMountTarget": "<p>Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target. </p> <p>You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p> <p>In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be \"available\" (see <a>DescribeFileSystems</a>).</p> <p> In the request, you also provide a subnet ID, which serves several purposes:</p> <ul> <li>It determines the VPC in which Amazon EFS creates the mount target.</li> <li>It determines the Availability Zone in which Amazon EFS creates the mount target. </li> <li>It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request. </li> </ul> <p>After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation\">How it Works: Implementation Overview</a> </p> <p> Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements: </p> <ul> <li> <p>The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.</p> </li> <li>The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.</li> </ul> <p>If the request satisfies the requirements, Amazon EFS does the following:</p> <ul> <li>Creates a new mount target in the specified subnet. </li> <li>Also creates a new network interface in the subnet as follows: <ul> <li>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</li> <li>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</li> <li>Assigns the description <code>\"Mount target <i>fsmt-id</i> for file system <i>fs-id</i>\"</code> where <code><i>fsmt-id</i></code> is the mount target ID, and <code><i>fs-id</i></code> is the <code>FileSystemId</code>.</li> <li>Sets the <code>requesterManaged</code> property of the network interface to \"true\", and the <code>requesterId</code> value to \"EFS\".</li> </ul> <p>Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails.</p> </li> </ul> <note>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still \"creating\". You can check the mount target creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the mount target state.</note> <p>We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to <a href=\"http://aws.amazon.com/efs/\">Amazon EFS</a> product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availablity Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. </p> <p>This operation requires permission for the following action on the file system:</p> <ul> <li><code>elasticfilesystem:CreateMountTarget</code></li> </ul> <p>This operation also requires permission for the following Amazon EC2 actions:</p> <ul> <li><code>ec2:DescribeSubnets</code></li> <li><code>ec2:DescribeNetworkInterfaces</code></li> <li><code>ec2:CreateNetworkInterface</code></li> </ul>",
4 "CreateMountTarget": "<p>Creates a mount target for a file system. You can then mount the file system on EC2 instances via the mount target. </p> <p>You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html\">Amazon EFS: How it Works</a>. </p> <p>In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be \"available\" (see <a>DescribeFileSystems</a>).</p> <p> In the request, you also provide a subnet ID, which serves several purposes:</p> <ul> <li>It determines the VPC in which Amazon EFS creates the mount target.</li> <li>It determines the Availability Zone in which Amazon EFS creates the mount target. </li> <li>It determines the IP address range from which Amazon EFS selects the IP address of the mount target if you don't specify an IP address in the request. </li> </ul> <p>After creating the mount target, Amazon EFS returns a response that includes, a <code>MountTargetId</code> and an <code>IpAddress</code>. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system via the mount target can resolve the mount target's DNS name to its IP address. For more information, see <a href=\"http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation\">How it Works: Implementation Overview</a>. </p> <p> Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the request to add another mount target must meet the following requirements: </p> <ul> <li> <p>The subnet specified in the request must belong to the same VPC as the subnets of the existing mount targets.</p> </li> <li>The subnet specified in the request must not be in the same Availability Zone as any of the subnets of the existing mount targets.</li> </ul> <p>If the request satisfies the requirements, Amazon EFS does the following:</p> <ul> <li>Creates a new mount target in the specified subnet. </li> <li>Also creates a new network interface in the subnet as follows: <ul> <li>If the request provides an <code>IpAddress</code>, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 <code>CreateNetworkInterface</code> call does when a request does not specify a primary private IP address).</li> <li>If the request provides <code>SecurityGroups</code>, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.</li> <li>Assigns the description <code>\"Mount target <i>fsmt-id</i> for file system <i>fs-id</i>\"</code> where <code><i>fsmt-id</i></code> is the mount target ID, and <code><i>fs-id</i></code> is the <code>FileSystemId</code>.</li> <li>Sets the <code>requesterManaged</code> property of the network interface to \"true\", and the <code>requesterId</code> value to \"EFS\".</li> </ul> <p>Each Amazon EFS mount target has one corresponding requestor-managed EC2 network interface. After the network interface is created, Amazon EFS sets the <code>NetworkInterfaceId</code> field in the mount target's description to the network interface ID, and the <code>IpAddress</code> field to its address. If network interface creation fails, the entire <code>CreateMountTarget</code> operation fails.</p> </li> </ul> <note>The <code>CreateMountTarget</code> call returns only after creating the network interface, but while the mount target state is still \"creating\". You can check the mount target creation status by calling the <a>DescribeFileSystems</a> API, which among other things returns the mount target state.</note> <p>We recommend you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, go to <a href=\"http://aws.amazon.com/efs/\">Amazon EFS</a> product detail page. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario; if the Availability Zone in which your mount target is created goes down, then you won't be able to access your file system through that mount target. </p> <p>This operation requires permission for the following action on the file system:</p> <ul> <li> <code>elasticfilesystem:CreateMountTarget</code> </li> </ul> <p>This operation also requires permission for the following Amazon EC2 actions:</p> <ul> <li> <code>ec2:DescribeSubnets</code> </li> <li> <code>ec2:DescribeNetworkInterfaces</code> </li> <li> <code>ec2:CreateNetworkInterface</code> </li> </ul>",
55 "CreateTags": "<p>Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the \"Name\" tag to your file system, Amazon EFS returns it in the response to the <a>DescribeFileSystems</a> API. </p> <p>This operation requires permission for the <code>elasticfilesystem:CreateTags</code> action.</p>",
66 "DeleteFileSystem": "<p> Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you will not be able to access any contents of the deleted file system. </p> <p> You cannot delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see <a>DescribeMountTargets</a> and <a>DeleteMountTarget</a>. </p> <note>The <code>DeleteFileSystem</code> call returns while the file system state is still \"deleting\". You can check the file system deletion status by calling the <a>DescribeFileSystems</a> API, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the <a>DescribeFileSystems</a> will return a 404 \"FileSystemNotFound\" error.</note> <p>This operation requires permission for the <code>elasticfilesystem:DeleteFileSystem</code> action.</p>",
7 "DeleteMountTarget": "<p>Deletes the specified mount target. </p> <p> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </p> <p> This operation requires permission for the following action on the file system: </p> <ul> <li><code>elasticfilesystem:DeleteMountTarget</code></li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still \"deleting\". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <p>The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:</p> <ul> <li><code>ec2:DeleteNetworkInterface</code></li> </ul>",
7 "DeleteMountTarget": "<p>Deletes the specified mount target. </p> <p> This operation forcibly breaks any mounts of the file system via the mount target being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes may be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC using another mount target. </p> <p> This operation requires permission for the following action on the file system: </p> <ul> <li> <code>elasticfilesystem:DeleteMountTarget</code> </li> </ul> <note>The <code>DeleteMountTarget</code> call returns while the mount target state is still \"deleting\". You can check the mount target deletion by calling the <a>DescribeMountTargets</a> API, which returns a list of mount target descriptions for the given file system. </note> <p>The operation also requires permission for the following Amazon EC2 action on the mount target's network interface:</p> <ul> <li> <code>ec2:DeleteNetworkInterface</code> </li> </ul>",
88 "DeleteTags": "<p>Deletes the specified tags from a file system. If the <code>DeleteTags</code> request includes a tag key that does not exist, Amazon EFS ignores it; it is not an error. For more information about tags and related restrictions, go to <a href=\"http://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> <p>This operation requires permission for the <code>elasticfilesystem:DeleteTags</code> action.</p>",
99 "DescribeFileSystems": "<p>Returns the description of a specific Amazon EFS file system if either the file system <code>CreationToken</code> or the <code>FileSystemId</code> is provided; otherwise, returns descriptions of all file systems owned by the caller's AWS account in the AWS region of the endpoint that you're calling.</p> <p> When retrieving all file system descriptions, you can optionally specify the <code>MaxItems</code> parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon EFS returns a <code>NextMarker</code>, an opaque token, in the response. In this case, you should send a subsequent request with the <code>Marker</code> request parameter set to the value of <code>NextMarker</code>. </p> <p> So to retrieve a list of your file system descriptions, the expected usage of this API is an iterative process of first calling <code>DescribeFileSystems</code> without the <code>Marker</code> and then continuing to call it with the <code>Marker</code> parameter set to the value of the <code>NextMarker</code> from the previous response until the response has no <code>NextMarker</code>. </p> <p> Note that the implementation may return fewer than <code>MaxItems</code> file system descriptions while still including a <code>NextMarker</code> value. </p> <p> The order of file systems returned in the response of one <code>DescribeFileSystems</code> call, and the order of file systems returned across the responses of a multi-call iteration, is unspecified. </p> <p> This operation requires permission for the <code>elasticfilesystem:DescribeFileSystems</code> action. </p>",
1010 "DescribeMountTargetSecurityGroups": "<p>Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not \"deleted\".</p> <p>This operation requires permissions for the following actions:</p> <ul> <li> <code>elasticfilesystem:DescribeMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:DescribeNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul>",
11 "DescribeMountTargets": "<p>Returns the descriptions of the current mount targets for a file system. The order of mount targets returned in the response is unspecified.</p> <p> This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action on the file system <code>FileSystemId</code>. </p>",
11 "DescribeMountTargets": "<p>Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.</p> <p>This operation requires permission for the <code>elasticfilesystem:DescribeMountTargets</code> action, on either the file system id that you specify in <code>FileSystemId</code>, or on the file system of the mount target that you specify in <code>MountTargetId</code>.</p>",
1212 "DescribeTags": "<p>Returns the tags associated with a file system. The order of tags returned in the response of one <code>DescribeTags</code> call, and the order of tags returned across the responses of a multi-call iteration (when using pagination), is unspecified. </p> <p> This operation requires permission for the <code>elasticfilesystem:DescribeTags</code> action. </p>",
1313 "ModifyMountTargetSecurityGroups": "<p>Modifies the set of security groups in effect for a mount target.</p> <p>When you create a mount target, Amazon EFS also creates a new network interface (see <a>CreateMountTarget</a>). This operation replaces the security groups in effect for the network interface associated with a mount target, with the <code>SecurityGroups</code> provided in the request. This operation requires that the network interface of the mount target has been created and the life cycle state of the mount target is not \"deleted\". </p> <p>The operation requires permissions for the following actions:</p> <ul> <li> <code>elasticfilesystem:ModifyMountTargetSecurityGroups</code> action on the mount target's file system. </li> <li> <code>ec2:ModifyNetworkInterfaceAttribute</code> action on the mount target's network interface. </li> </ul>"
1414 },
180180 "DeleteFileSystemRequest$FileSystemId": "<p>The ID of the file system you want to delete.</p>",
181181 "DeleteTagsRequest$FileSystemId": "<p>String. The ID of the file system whose tags you want to delete.</p>",
182182 "DescribeFileSystemsRequest$FileSystemId": "<p>Optional string. File system ID whose description you want to retrieve. </p>",
183 "DescribeMountTargetsRequest$FileSystemId": "<p>String. The ID of the file system whose mount targets you want to list.</p>",
183 "DescribeMountTargetsRequest$FileSystemId": "<p>Optional. String. The ID of the file system whose mount targets you want to list. It must be included in your request if <code>MountTargetId</code> is not included.</p>",
184184 "DescribeTagsRequest$FileSystemId": "<p>The ID of the file system whose tag set you want to retrieve.</p>",
185185 "FileSystemAlreadyExists$FileSystemId": null,
186186 "FileSystemDescription$FileSystemId": "<p>The file system ID assigned by Amazon EFS.</p>",
303303 "refs": {
304304 "DeleteMountTargetRequest$MountTargetId": "<p>String. The ID of the mount target to delete.</p>",
305305 "DescribeMountTargetSecurityGroupsRequest$MountTargetId": "<p>The ID of the mount target whose security groups you want to retrieve.</p>",
306 "DescribeMountTargetsRequest$MountTargetId": "<p>Optional. String. The ID of the mount target that you want to have described. It must be included in your request if <code>FileSystemId</code> is not included.</p>",
306307 "ModifyMountTargetSecurityGroupsRequest$MountTargetId": "<p>The ID of the mount target whose security groups you want to modify.</p>",
307308 "MountTargetDescription$MountTargetId": "<p>The system-assigned mount target ID. </p>"
308309 }
309310 },
310311 "MountTargetNotFound": {
311 "base": "<p>Returned if there is no mount target with the specified ID is found in the caller's account.</p>",
312 "base": "<p>Returned if there is no mount target with the specified ID found in the caller's account.</p>",
312313 "refs": {
313314 }
314315 },
+324
-0
apis/iam/2010-05-08/api-2.json less more
20522052 }
20532053 ]
20542054 },
2055 "GetContextKeysForCustomPolicy":{
2056 "name":"GetContextKeysForCustomPolicy",
2057 "http":{
2058 "method":"POST",
2059 "requestUri":"/"
2060 },
2061 "input":{"shape":"GetContextKeysForCustomPolicyRequest"},
2062 "output":{
2063 "shape":"GetContextKeysForPolicyResponse",
2064 "resultWrapper":"GetContextKeysForCustomPolicyResult"
2065 },
2066 "errors":[
2067 {
2068 "shape":"InvalidInputException",
2069 "error":{
2070 "code":"InvalidInput",
2071 "httpStatusCode":400,
2072 "senderFault":true
2073 },
2074 "exception":true
2075 }
2076 ]
2077 },
2078 "GetContextKeysForPrincipalPolicy":{
2079 "name":"GetContextKeysForPrincipalPolicy",
2080 "http":{
2081 "method":"POST",
2082 "requestUri":"/"
2083 },
2084 "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"},
2085 "output":{
2086 "shape":"GetContextKeysForPolicyResponse",
2087 "resultWrapper":"GetContextKeysForPrincipalPolicyResult"
2088 },
2089 "errors":[
2090 {
2091 "shape":"NoSuchEntityException",
2092 "error":{
2093 "code":"NoSuchEntity",
2094 "httpStatusCode":404,
2095 "senderFault":true
2096 },
2097 "exception":true
2098 },
2099 {
2100 "shape":"InvalidInputException",
2101 "error":{
2102 "code":"InvalidInput",
2103 "httpStatusCode":400,
2104 "senderFault":true
2105 },
2106 "exception":true
2107 }
2108 ]
2109 },
20552110 "GetCredentialReport":{
20562111 "name":"GetCredentialReport",
20572112 "http":{
35793634 "shape":"ServiceFailureException",
35803635 "error":{
35813636 "code":"ServiceFailure",
3637 "httpStatusCode":500
3638 },
3639 "exception":true
3640 }
3641 ]
3642 },
3643 "SimulateCustomPolicy":{
3644 "name":"SimulateCustomPolicy",
3645 "http":{
3646 "method":"POST",
3647 "requestUri":"/"
3648 },
3649 "input":{"shape":"SimulateCustomPolicyRequest"},
3650 "output":{
3651 "shape":"SimulatePolicyResponse",
3652 "resultWrapper":"SimulateCustomPolicyResult"
3653 },
3654 "errors":[
3655 {
3656 "shape":"InvalidInputException",
3657 "error":{
3658 "code":"InvalidInput",
3659 "httpStatusCode":400,
3660 "senderFault":true
3661 },
3662 "exception":true
3663 },
3664 {
3665 "shape":"PolicyEvaluationException",
3666 "error":{
3667 "code":"PolicyEvaluation",
3668 "httpStatusCode":500
3669 },
3670 "exception":true
3671 }
3672 ]
3673 },
3674 "SimulatePrincipalPolicy":{
3675 "name":"SimulatePrincipalPolicy",
3676 "http":{
3677 "method":"POST",
3678 "requestUri":"/"
3679 },
3680 "input":{"shape":"SimulatePrincipalPolicyRequest"},
3681 "output":{
3682 "shape":"SimulatePolicyResponse",
3683 "resultWrapper":"SimulatePrincipalPolicyResult"
3684 },
3685 "errors":[
3686 {
3687 "shape":"NoSuchEntityException",
3688 "error":{
3689 "code":"NoSuchEntity",
3690 "httpStatusCode":404,
3691 "senderFault":true
3692 },
3693 "exception":true
3694 },
3695 {
3696 "shape":"InvalidInputException",
3697 "error":{
3698 "code":"InvalidInput",
3699 "httpStatusCode":400,
3700 "senderFault":true
3701 },
3702 "exception":true
3703 },
3704 {
3705 "shape":"PolicyEvaluationException",
3706 "error":{
3707 "code":"PolicyEvaluation",
35823708 "httpStatusCode":500
35833709 },
35843710 "exception":true
42824408 "CreateDate":{"shape":"dateType"}
42834409 }
42844410 },
4411 "ActionNameListType":{
4412 "type":"list",
4413 "member":{"shape":"ActionNameType"}
4414 },
4415 "ActionNameType":{
4416 "type":"string",
4417 "min":3,
4418 "max":128
4419 },
42854420 "AddClientIDToOpenIDConnectProviderRequest":{
42864421 "type":"structure",
42874422 "required":[
43704505 "NewPassword":{"shape":"passwordType"}
43714506 }
43724507 },
4508 "ColumnNumber":{"type":"integer"},
4509 "ContextEntry":{
4510 "type":"structure",
4511 "members":{
4512 "ContextKeyName":{"shape":"ContextKeyNameType"},
4513 "ContextKeyValues":{"shape":"ContextKeyValueListType"},
4514 "ContextKeyType":{"shape":"ContextKeyTypeEnum"}
4515 }
4516 },
4517 "ContextEntryListType":{
4518 "type":"list",
4519 "member":{"shape":"ContextEntry"}
4520 },
4521 "ContextKeyNameType":{
4522 "type":"string",
4523 "min":5,
4524 "max":256
4525 },
4526 "ContextKeyNamesResultListType":{
4527 "type":"list",
4528 "member":{"shape":"ContextKeyNameType"}
4529 },
4530 "ContextKeyTypeEnum":{
4531 "type":"string",
4532 "enum":[
4533 "string",
4534 "stringList",
4535 "numeric",
4536 "numericList",
4537 "boolean",
4538 "booleanList",
4539 "ip",
4540 "ipList",
4541 "binary",
4542 "binaryList",
4543 "date",
4544 "dateList"
4545 ]
4546 },
4547 "ContextKeyValueListType":{
4548 "type":"list",
4549 "member":{"shape":"ContextKeyValueType"}
4550 },
4551 "ContextKeyValueType":{"type":"string"},
43734552 "CreateAccessKeyRequest":{
43744553 "type":"structure",
43754554 "members":{
48725051 "AWSManagedPolicy"
48735052 ]
48745053 },
5054 "EvaluationResult":{
5055 "type":"structure",
5056 "required":[
5057 "EvalActionName",
5058 "EvalResourceName",
5059 "EvalDecision"
5060 ],
5061 "members":{
5062 "EvalActionName":{"shape":"ActionNameType"},
5063 "EvalResourceName":{"shape":"ResourceNameType"},
5064 "EvalDecision":{"shape":"PolicyEvaluationDecisionType"},
5065 "MatchedStatements":{"shape":"StatementListType"},
5066 "MissingContextValues":{"shape":"ContextKeyNamesResultListType"}
5067 }
5068 },
5069 "EvaluationResultsListType":{
5070 "type":"list",
5071 "member":{"shape":"EvaluationResult"}
5072 },
48755073 "GenerateCredentialReportResponse":{
48765074 "type":"structure",
48775075 "members":{
49235121 "type":"structure",
49245122 "members":{
49255123 "SummaryMap":{"shape":"summaryMapType"}
5124 }
5125 },
5126 "GetContextKeysForCustomPolicyRequest":{
5127 "type":"structure",
5128 "required":["PolicyInputList"],
5129 "members":{
5130 "PolicyInputList":{"shape":"SimulationPolicyListType"}
5131 }
5132 },
5133 "GetContextKeysForPolicyResponse":{
5134 "type":"structure",
5135 "members":{
5136 "ContextKeyNames":{"shape":"ContextKeyNamesResultListType"}
5137 }
5138 },
5139 "GetContextKeysForPrincipalPolicyRequest":{
5140 "type":"structure",
5141 "required":["PolicySourceArn"],
5142 "members":{
5143 "PolicySourceArn":{"shape":"arnType"},
5144 "PolicyInputList":{"shape":"SimulationPolicyListType"}
49265145 }
49275146 },
49285147 "GetCredentialReportResponse":{
53085527 },
53095528 "exception":true
53105529 },
5530 "LineNumber":{"type":"integer"},
53115531 "ListAccessKeysRequest":{
53125532 "type":"structure",
53135533 "members":{
58606080 "PolicyDocument":{"shape":"policyDocumentType"}
58616081 }
58626082 },
6083 "PolicyEvaluationDecisionType":{
6084 "type":"string",
6085 "enum":[
6086 "allowed",
6087 "explicitDeny",
6088 "implicitDeny"
6089 ]
6090 },
6091 "PolicyEvaluationException":{
6092 "type":"structure",
6093 "members":{
6094 "message":{"shape":"policyEvaluationErrorMessage"}
6095 },
6096 "error":{
6097 "code":"PolicyEvaluation",
6098 "httpStatusCode":500
6099 },
6100 "exception":true
6101 },
58636102 "PolicyGroup":{
58646103 "type":"structure",
58656104 "members":{
58706109 "type":"list",
58716110 "member":{"shape":"PolicyGroup"}
58726111 },
6112 "PolicyIdentifierType":{"type":"string"},
58736113 "PolicyRole":{
58746114 "type":"structure",
58756115 "members":{
58796119 "PolicyRoleListType":{
58806120 "type":"list",
58816121 "member":{"shape":"PolicyRole"}
6122 },
6123 "PolicySourceType":{
6124 "type":"string",
6125 "enum":[
6126 "user",
6127 "group",
6128 "role",
6129 "aws-managed",
6130 "user-managed",
6131 "none"
6132 ]
58826133 },
58836134 "PolicyUser":{
58846135 "type":"structure",
58976148 "VersionId":{"shape":"policyVersionIdType"},
58986149 "IsDefaultVersion":{"shape":"booleanType"},
58996150 "CreateDate":{"shape":"dateType"}
6151 }
6152 },
6153 "Position":{
6154 "type":"structure",
6155 "members":{
6156 "Line":{"shape":"LineNumber"},
6157 "Column":{"shape":"ColumnNumber"}
59006158 }
59016159 },
59026160 "PutGroupPolicyRequest":{
59846242 "INPROGRESS",
59856243 "COMPLETE"
59866244 ]
6245 },
6246 "ResourceNameListType":{
6247 "type":"list",
6248 "member":{"shape":"ResourceNameType"}
6249 },
6250 "ResourceNameType":{
6251 "type":"string",
6252 "min":1,
6253 "max":2048
59876254 },
59886255 "ResyncMFADeviceRequest":{
59896256 "type":"structure",
61586425 "Status":{"shape":"statusType"},
61596426 "UploadDate":{"shape":"dateType"}
61606427 }
6428 },
6429 "SimulateCustomPolicyRequest":{
6430 "type":"structure",
6431 "required":[
6432 "PolicyInputList",
6433 "ActionNames"
6434 ],
6435 "members":{
6436 "PolicyInputList":{"shape":"SimulationPolicyListType"},
6437 "ActionNames":{"shape":"ActionNameListType"},
6438 "ResourceArns":{"shape":"ResourceNameListType"},
6439 "ContextEntries":{"shape":"ContextEntryListType"},
6440 "MaxItems":{"shape":"maxItemsType"},
6441 "Marker":{"shape":"markerType"}
6442 }
6443 },
6444 "SimulatePolicyResponse":{
6445 "type":"structure",
6446 "members":{
6447 "EvaluationResults":{"shape":"EvaluationResultsListType"},
6448 "IsTruncated":{"shape":"booleanType"},
6449 "Marker":{"shape":"markerType"}
6450 }
6451 },
6452 "SimulatePrincipalPolicyRequest":{
6453 "type":"structure",
6454 "required":[
6455 "PolicySourceArn",
6456 "ActionNames"
6457 ],
6458 "members":{
6459 "PolicySourceArn":{"shape":"arnType"},
6460 "PolicyInputList":{"shape":"SimulationPolicyListType"},
6461 "ActionNames":{"shape":"ActionNameListType"},
6462 "ResourceArns":{"shape":"ResourceNameListType"},
6463 "ContextEntries":{"shape":"ContextEntryListType"},
6464 "MaxItems":{"shape":"maxItemsType"},
6465 "Marker":{"shape":"markerType"}
6466 }
6467 },
6468 "SimulationPolicyListType":{
6469 "type":"list",
6470 "member":{"shape":"policyDocumentType"}
6471 },
6472 "Statement":{
6473 "type":"structure",
6474 "members":{
6475 "SourcePolicyId":{"shape":"PolicyIdentifierType"},
6476 "SourcePolicyType":{"shape":"PolicySourceType"},
6477 "StartPosition":{"shape":"Position"},
6478 "EndPosition":{"shape":"Position"}
6479 }
6480 },
6481 "StatementListType":{
6482 "type":"list",
6483 "member":{"shape":"Statement"}
61616484 },
61626485 "UnrecognizedPublicKeyEncodingException":{
61636486 "type":"structure",
66166939 "type":"list",
66176940 "member":{"shape":"PolicyVersion"}
66186941 },
6942 "policyEvaluationErrorMessage":{"type":"string"},
66196943 "policyListType":{
66206944 "type":"list",
66216945 "member":{"shape":"Policy"}
+332
-135
apis/iam/2010-05-08/docs-2.json less more
33 "AddClientIDToOpenIDConnectProvider": "<p>Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect provider.</p> <p>This action is idempotent; it does not fail or return an error if you add an existing client ID to the provider.</p>",
44 "AddRoleToInstanceProfile": "<p>Adds the specified role to the specified instance profile. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p>",
55 "AddUserToGroup": "<p>Adds the specified user to the specified group.</p>",
6 "AttachGroupPolicy": "<p>Attaches the specified managed policy to the specified group.</p> <p>You use this API to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
7 "AttachRolePolicy": "<p>Attaches the specified managed policy to the specified role.</p> <p>When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. </p> <p>Use this API to attach a managed policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide.</p>",
8 "AttachUserPolicy": "<p>Attaches the specified managed policy to the specified user.</p> <p>You use this API to attach a managed policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
9 "ChangePassword": "<p>Changes the password of the IAM user who is calling this action. The root account password is not affected by this action. </p> <p>To change the password for a different user, see <a>UpdateLoginProfile</a>. For more information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>Using IAM</i> guide. </p>",
10 "CreateAccessKey": "<p> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. </p> <p> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <p> For information about limits on the number of keys you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important>",
11 "CreateAccountAlias": "<p>Creates an alias for your AWS account. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>Using IAM</i> guide. </p>",
12 "CreateGroup": "<p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p>",
13 "CreateInstanceProfile": "<p> Creates a new instance profile. For information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p> <p> For information about the number of instance profiles you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p>",
6 "AttachGroupPolicy": "<p>Attaches the specified managed policy to the specified group.</p> <p>You use this API to attach a managed policy to a group. To embed an inline policy in a group, use <a>PutGroupPolicy</a>. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
7 "AttachRolePolicy": "<p>Attaches the specified managed policy to the specified role.</p> <p>When you attach a managed policy to a role, the managed policy is used as the role's access (permissions) policy. You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. </p> <p>Use this API to attach a managed policy to a role. To embed an inline policy in a role, use <a>PutRolePolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>.</p>",
8 "AttachUserPolicy": "<p>Attaches the specified managed policy to the specified user.</p> <p>You use this API to attach a managed policy to a user. To embed an inline policy in a user, use <a>PutUserPolicy</a>. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
9 "ChangePassword": "<p>Changes the password of the IAM user who is calling this action. The root account password is not affected by this action. </p> <p>To change the password for a different user, see <a>UpdateLoginProfile</a>. For more information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>IAM User Guide</i>. </p>",
10 "CreateAccessKey": "<p> Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is <code>Active</code>. </p> <p> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <p> For information about limits on the number of keys you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <important> To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys. </important>",
11 "CreateAccountAlias": "<p>Creates an alias for your AWS account. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </p>",
12 "CreateGroup": "<p>Creates a new group.</p> <p> For information about the number of groups you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p>",
13 "CreateInstanceProfile": "<p> Creates a new instance profile. For information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p> <p> For information about the number of instance profiles you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p>",
1414 "CreateLoginProfile": "<p> Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>Using IAM</i> guide. </p>",
1515 "CreateOpenIDConnectProvider": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports <a href=\"http://openid.net/connect/\">OpenID Connect (OIDC)</a>. </p> <p>The OIDC provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and the OIDC provider. </p> <p>When you create the IAM OIDC provider, you specify the URL of the OIDC identity provider (IdP) to trust, a list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider, and a list of thumbprints of the server certificate(s) that the IdP uses. You get all of this information from the OIDC IdP that you want to use for access to AWS. </p> <note>Because trust for the OIDC provider is ultimately derived from the IAM provider that this action creates, it is a best practice to limit access to the <a>CreateOpenIDConnectProvider</a> action to highly-privileged users. </note>",
16 "CreatePolicy": "<p>Creates a new managed policy for your AWS account. </p> <p>This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p> <p>For more information about managed policies in general, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
17 "CreatePolicyVersion": "<p>Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version. </p> <p>Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. </p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
18 "CreateRole": "<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <p>The policy in the following example grants permission to an EC2 instance to assume the role.</p>",
19 "CreateSAMLProvider": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.</p> <p> The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. </p> <p> When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </p> <note> This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note> <p> For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/STSMgmtConsole-SAML.html\">Giving Console Access Using SAML</a> and <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary Credentials</i> guide. </p>",
20 "CreateUser": "<p>Creates a new user for your AWS account.</p> <p> For information about limitations on the number of users you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p>",
16 "CreatePolicy": "<p>Creates a new managed policy for your AWS account. </p> <p>This operation creates a policy version with a version identifier of <code>v1</code> and sets v1 as the policy's default version. For more information about policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p> <p>For more information about managed policies in general, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
17 "CreatePolicyVersion": "<p>Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using <a>DeletePolicyVersion</a> before you create a new version. </p> <p>Optionally, you can set the new version as the policy's default version. The default version is the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to. </p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
18 "CreateRole": "<p>Creates a new role for your AWS account. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For information about limitations on role names and the number of roles you can create, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <p>The policy in the following example grants permission to an EC2 instance to assume the role.</p>",
19 "CreateSAMLProvider": "<p>Creates an IAM entity to describe an identity provider (IdP) that supports SAML 2.0.</p> <p> The SAML provider that you create with this operation can be used as a principal in a role's trust policy to establish a trust relationship between AWS and a SAML identity provider. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS. </p> <p> When you create the SAML provider, you upload an a SAML metadata document that you get from your IdP and that includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </p> <note> This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note> <p> For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html\">Enabling SAML 2.0 Federated Users to Access the AWS Management Console</a> and <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html\">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i>. </p>",
20 "CreateUser": "<p>Creates a new user for your AWS account.</p> <p> For information about limitations on the number of users you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p>",
2121 "CreateVirtualMFADevice": "<p>Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use <a>EnableMFADevice</a> to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </p> <p>For information about limits on the number of MFA devices you can create, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on Entities</a> in the <i>Using IAM</i> guide. </p> <important>The seed information contained in the QR code and the Base32 string should be treated like any other secret access information, such as your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures. </important>",
2222 "DeactivateMFADevice": "<p>Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled. </p> <p>For more information about creating and working with virtual MFA devices, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </p>",
2323 "DeleteAccessKey": "<p>Deletes the access key associated with the specified user.</p> <p> If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p>",
24 "DeleteAccountAlias": "<p> Deletes the specified AWS account alias. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>Using IAM</i> guide. </p>",
24 "DeleteAccountAlias": "<p> Deletes the specified AWS account alias. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </p>",
2525 "DeleteAccountPasswordPolicy": "<p>Deletes the password policy for the AWS account.</p>",
2626 "DeleteGroup": "<p> Deletes the specified group. The group must not contain any users or have any attached policies. </p>",
27 "DeleteGroupPolicy": "<p>Deletes the specified inline policy that is embedded in the specified group.</p> <p>A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
27 "DeleteGroupPolicy": "<p>Deletes the specified inline policy that is embedded in the specified group.</p> <p>A group can also have managed policies attached to it. To detach a managed policy from a group, use <a>DetachGroupPolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
2828 "DeleteInstanceProfile": "<p>Deletes the specified instance profile. The instance profile must not have an associated role. </p> <important> Make sure you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important> <p>For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p>",
2929 "DeleteLoginProfile": "<p> Deletes the password for the specified user, which terminates the user's ability to access AWS services through the AWS Management Console. </p> <important> Deleting a user's password does not prevent a user from accessing IAM through the command line interface or the API. To prevent all user access you must also either make the access key inactive or delete it. For more information about making keys inactive or deleting them, see <a>UpdateAccessKey</a> and <a>DeleteAccessKey</a>. </important>",
3030 "DeleteOpenIDConnectProvider": "<p>Deletes an IAM OpenID Connect identity provider.</p> <p>Deleting an OIDC provider does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a provider that has been deleted will fail. </p> <p>This action is idempotent; it does not fail or return an error if you call the action for a provider that was already deleted.</p>",
31 "DeletePolicy": "<p>Deletes the specified managed policy.</p> <p>Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy: <ol> <li>Detach the policy from all users, groups, and roles that the policy is attached to, using the <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a> APIs. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>. </li> <li>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. </li> <li>Delete the policy (this automatically deletes the policy's default version) using this API. </li> </ol> </p> <p>For information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
32 "DeletePolicyVersion": "<p>Deletes the specified version of the specified managed policy.</p> <p>You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>. </p> <p>For information about versions for managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
31 "DeletePolicy": "<p>Deletes the specified managed policy.</p> <p>Before you can delete a managed policy, you must detach the policy from all users, groups, and roles that it is attached to, and you must delete all of the policy's versions. The following steps describe the process for deleting a managed policy: <ol> <li>Detach the policy from all users, groups, and roles that the policy is attached to, using the <a>DetachUserPolicy</a>, <a>DetachGroupPolicy</a>, or <a>DetachRolePolicy</a> APIs. To list all the users, groups, and roles that a policy is attached to, use <a>ListEntitiesForPolicy</a>. </li> <li>Delete all versions of the policy using <a>DeletePolicyVersion</a>. To list the policy's versions, use <a>ListPolicyVersions</a>. You cannot use <a>DeletePolicyVersion</a> to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process. </li> <li>Delete the policy (this automatically deletes the policy's default version) using this API. </li> </ol> </p> <p>For information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
32 "DeletePolicyVersion": "<p>Deletes the specified version of the specified managed policy.</p> <p>You cannot delete the default version of a policy using this API. To delete the default version of a policy, use <a>DeletePolicy</a>. To find out which version of a policy is marked as the default version, use <a>ListPolicyVersions</a>. </p> <p>For information about versions for managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
3333 "DeleteRole": "<p>Deletes the specified role. The role must not have any policies attached. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. </p> <important>Make sure you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance. </important>",
34 "DeleteRolePolicy": "<p>Deletes the specified inline policy that is embedded in the specified role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
34 "DeleteRolePolicy": "<p>Deletes the specified inline policy that is embedded in the specified role.</p> <p>A role can also have managed policies attached to it. To detach a managed policy from a role, use <a>DetachRolePolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
3535 "DeleteSAMLProvider": "<p>Deletes a SAML provider.</p> <p> Deleting the provider does not update any roles that reference the SAML provider as a principal in their trust policies. Any attempt to assume a role that references a SAML provider that has been deleted will fail. </p> <note> This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note>",
3636 "DeleteSSHPublicKey": "<p>Deletes the specified SSH public key.</p> <p>The SSH public key deleted by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
3737 "DeleteServerCertificate": "<p>Deletes the specified server certificate.</p> <important> If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to <a href=\"http://docs.aws.amazon.com/ElasticLoadBalancing/latest/APIReference/API_DeleteLoadBalancerListeners.html\">DeleteLoadBalancerListeners</a> in the <i>Elastic Load Balancing API Reference</i>. </important>",
3838 "DeleteSigningCertificate": "<p>Deletes the specified signing certificate associated with the specified user.</p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p>",
3939 "DeleteUser": "<p> Deletes the specified user. The user must not belong to any groups, have any keys or signing certificates, or have any attached policies. </p>",
40 "DeleteUserPolicy": "<p>Deletes the specified inline policy that is embedded in the specified user.</p> <p>A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
40 "DeleteUserPolicy": "<p>Deletes the specified inline policy that is embedded in the specified user.</p> <p>A user can also have managed policies attached to it. To detach a managed policy from a user, use <a>DetachUserPolicy</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
4141 "DeleteVirtualMFADevice": "<p>Deletes a virtual MFA device.</p> <note> You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see <a>DeactivateMFADevice</a>. </note>",
42 "DetachGroupPolicy": "<p>Removes the specified managed policy from the specified group. </p> <p>A group can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteGroupPolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
43 "DetachRolePolicy": "<p>Removes the specified managed policy from the specified role. </p> <p>A role can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteRolePolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
44 "DetachUserPolicy": "<p>Removes the specified managed policy from the specified user. </p> <p>A user can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteUserPolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
42 "DetachGroupPolicy": "<p>Removes the specified managed policy from the specified group. </p> <p>A group can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteGroupPolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
43 "DetachRolePolicy": "<p>Removes the specified managed policy from the specified role. </p> <p>A role can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteRolePolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
44 "DetachUserPolicy": "<p>Removes the specified managed policy from the specified user. </p> <p>A user can also have inline policies embedded with it. To delete an inline policy, use the <a>DeleteUserPolicy</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
4545 "EnableMFADevice": "<p> Enables the specified MFA device and associates it with the specified user name. When enabled, the MFA device is required for every subsequent login by the user name associated with the device. </p>",
46 "GenerateCredentialReport": "<p> Generates a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide. </p>",
46 "GenerateCredentialReport": "<p> Generates a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </p>",
4747 "GetAccessKeyLastUsed": "<p>Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and region that were specified in the last request made with that key.</p>",
48 "GetAccountAuthorizationDetails": "<p>Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.</p> <p>You can optionally filter the results using the <code>Filter</code> parameter. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>",
48 "GetAccountAuthorizationDetails": "<p>Retrieves information about all IAM users, groups, roles, and policies in your account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.</p> <p>You can optionally filter the results using the <code>Filter</code> parameter. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
4949 "GetAccountPasswordPolicy": "<p>Retrieves the password policy for the AWS account. For more information about using a password policy, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an IAM Password Policy</a>. </p>",
50 "GetAccountSummary": "<p>Retrieves information about IAM entity usage and IAM quotas in the AWS account.</p> <p> For information about limitations on IAM entities, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p>",
51 "GetCredentialReport": "<p> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide. </p>",
50 "GetAccountSummary": "<p>Retrieves information about IAM entity usage and IAM quotas in the AWS account.</p> <p> For information about limitations on IAM entities, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p>",
51 "GetContextKeysForCustomPolicy": "<p>Gets a list of all of the context keys referenced in <code>Condition</code> elements in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use <a>GetContextKeysForPrincipalPolicy</a>.</p> <p>Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call <a>SimulateCustomPolicy</a>. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</p>",
52 "GetContextKeysForPrincipalPolicy": "<p>Gets a list of all of the context keys referenced in <code>Condition</code> elements in all of the IAM policies attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.</p> <p>You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use <a>GetContextKeysForCustomPolicy</a> instead.</p> <p><b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>GetContextKeysForCustomPolicy</a> instead.</p> <p>Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call <a>SimulatePrincipalPolicy</a>.</p>",
53 "GetCredentialReport": "<p> Retrieves a credential report for the AWS account. For more information about the credential report, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>IAM User Guide</i>. </p>",
5254 "GetGroup": "<p> Returns a list of users that are in the specified group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
53 "GetGroupPolicy": "<p>Retrieves the specified inline policy document that is embedded in the specified group. </p> <p>A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
55 "GetGroupPolicy": "<p>Retrieves the specified inline policy document that is embedded in the specified group. </p> <p>A group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
5456 "GetInstanceProfile": "<p> Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. For more information about ARNs, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs\">ARNs</a>. </p>",
5557 "GetLoginProfile": "<p>Retrieves the user name and password-creation date for the specified user. If the user has not been assigned a password, the action returns a 404 (<code>NoSuchEntity</code>) error. </p>",
5658 "GetOpenIDConnectProvider": "<p>Returns information about the specified OpenID Connect provider.</p>",
57 "GetPolicy": "<p>Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use <a>GetPolicyVersion</a>. </p> <p>This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
58 "GetPolicyVersion": "<p>Retrieves information about the specified version of the specified managed policy, including the policy document. </p> <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>. </p> <p>This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </p> <p>For more information about the types of policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
59 "GetPolicy": "<p>Retrieves information about the specified managed policy, including the policy's default version and the total number of users, groups, and roles that the policy is attached to. For a list of the specific users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. This API returns metadata about the policy. To retrieve the policy document for a specific version of the policy, use <a>GetPolicyVersion</a>. </p> <p>This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
60 "GetPolicyVersion": "<p>Retrieves information about the specified version of the specified managed policy, including the policy document. </p> <p>To list the available versions for a policy, use <a>ListPolicyVersions</a>. </p> <p>This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the <a>GetUserPolicy</a>, <a>GetGroupPolicy</a>, or <a>GetRolePolicy</a> API. </p> <p>For more information about the types of policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
5961 "GetRole": "<p>Retrieves information about the specified role, including the role's path, GUID, ARN, and the policy granting permission to assume the role. For more information about ARNs, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html#Identifiers_ARNs\">ARNs</a>. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. </p>",
60 "GetRolePolicy": "<p>Retrieves the specified inline policy document that is embedded with the specified role. </p> <p>A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>. </p>",
62 "GetRolePolicy": "<p>Retrieves the specified inline policy document that is embedded with the specified role. </p> <p>A role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>. </p>",
6163 "GetSAMLProvider": "<p>Returns the SAML provider metadocument that was uploaded when the provider was created or updated. </p> <note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note>",
6264 "GetSSHPublicKey": "<p>Retrieves the specified SSH public key, including metadata about the key.</p> <p>The SSH public key retrieved by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
6365 "GetServerCertificate": "<p>Retrieves information about the specified server certificate.</p>",
6466 "GetUser": "<p>Retrieves information about the specified user, including the user's creation date, path, unique ID, and ARN. </p> <p>If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request. </p>",
65 "GetUserPolicy": "<p>Retrieves the specified inline policy document that is embedded in the specified user. </p> <p>A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
67 "GetUserPolicy": "<p>Retrieves the specified inline policy document that is embedded in the specified user. </p> <p>A user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use <a>GetPolicy</a> to determine the policy's default version, then use <a>GetPolicyVersion</a> to retrieve the policy document. </p> <p>For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
6668 "ListAccessKeys": "<p>Returns information about the access key IDs associated with the specified user. If there are none, the action returns an empty list. </p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p> <p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <note>To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. </note>",
67 "ListAccountAliases": "<p> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>Using IAM</i> guide. </p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
68 "ListAttachedGroupPolicies": "<p>Lists all managed policies that are attached to the specified group.</p> <p>A group can also have inline policies embedded with it. To list the inline policies for a group, use the <a>ListGroupPolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </p>",
69 "ListAttachedRolePolicies": "<p>Lists all managed policies that are attached to the specified role. </p> <p>A role can also have inline policies embedded with it. To list the inline policies for a role, use the <a>ListRolePolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list. </p>",
70 "ListAttachedUserPolicies": "<p>Lists all managed policies that are attached to the specified user. </p> <p>A user can also have inline policies embedded with it. To list the inline policies for a user, use the <a>ListUserPolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </p>",
69 "ListAccountAliases": "<p> Lists the account aliases associated with the account. For information about using an AWS account alias, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html\">Using an Alias for Your AWS Account ID</a> in the <i>IAM User Guide</i>. </p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
70 "ListAttachedGroupPolicies": "<p>Lists all managed policies that are attached to the specified group.</p> <p>A group can also have inline policies embedded with it. To list the inline policies for a group, use the <a>ListGroupPolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </p>",
71 "ListAttachedRolePolicies": "<p>Lists all managed policies that are attached to the specified role. </p> <p>A role can also have inline policies embedded with it. To list the inline policies for a role, use the <a>ListRolePolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the action returns an empty list. </p>",
72 "ListAttachedUserPolicies": "<p>Lists all managed policies that are attached to the specified user. </p> <p>A user can also have inline policies embedded with it. To list the inline policies for a user, use the <a>ListUserPolicies</a> API. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. You can use the <code>PathPrefix</code> parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the action returns an empty list. </p>",
7173 "ListEntitiesForPolicy": "<p>Lists all users, groups, and roles that the specified managed policy is attached to. </p> <p>You can use the optional <code>EntityFilter</code> parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set <code>EntityFilter</code> to <code>Role</code>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
72 "ListGroupPolicies": "<p>Lists the names of the inline policies that are embedded in the specified group. </p> <p>A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the action returns an empty list. </p>",
74 "ListGroupPolicies": "<p>Lists the names of the inline policies that are embedded in the specified group. </p> <p>A group can also have managed policies attached to it. To list the managed policies that are attached to a group, use <a>ListAttachedGroupPolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified group, the action returns an empty list. </p>",
7375 "ListGroups": "<p>Lists the groups that have the specified path prefix.</p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
7476 "ListGroupsForUser": "<p>Lists the groups the specified user belongs to.</p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
7577 "ListInstanceProfiles": "<p>Lists the instance profiles that have the specified path prefix. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
7678 "ListInstanceProfilesForRole": "<p>Lists the instance profiles that have the specified associated role. If there are none, the action returns an empty list. For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
7779 "ListMFADevices": "<p>Lists the MFA devices. If the request includes the user name, then this action lists all the MFA devices associated with the specified user name. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
7880 "ListOpenIDConnectProviders": "<p>Lists information about the OpenID Connect providers in the AWS account. </p>",
79 "ListPolicies": "<p>Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. </p> <p>You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
80 "ListPolicyVersions": "<p>Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
81 "ListRolePolicies": "<p>Lists the names of the inline policies that are embedded in the specified role. </p> <p>A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the action returns an empty list. </p>",
81 "ListPolicies": "<p>Lists all the managed policies that are available to your account, including your own customer managed policies and all AWS managed policies. </p> <p>You can filter the list of policies that is returned using the optional <code>OnlyAttached</code>, <code>Scope</code>, and <code>PathPrefix</code> parameters. For example, to list only the customer managed policies in your AWS account, set <code>Scope</code> to <code>Local</code>. To list only AWS managed policies, set <code>Scope</code> to <code>AWS</code>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
82 "ListPolicyVersions": "<p>Lists information about the versions of the specified managed policy, including the version that is set as the policy's default version. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
83 "ListRolePolicies": "<p>Lists the names of the inline policies that are embedded in the specified role. </p> <p>A role can also have managed policies attached to it. To list the managed policies that are attached to a role, use <a>ListAttachedRolePolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified role, the action returns an empty list. </p>",
8284 "ListRoles": "<p>Lists the roles that have the specified path prefix. If there are none, the action returns an empty list. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
8385 "ListSAMLProviders": "<p>Lists the SAML providers in the account.</p> <note> This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note>",
8486 "ListSSHPublicKeys": "<p>Returns information about the SSH public keys associated with the specified IAM user. If there are none, the action returns an empty list.</p> <p>The SSH public keys returned by this action are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p> <p>Although each user is limited to a small number of keys, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>",
8587 "ListServerCertificates": "<p> Lists the server certificates that have the specified path prefix. If none exist, the action returns an empty list. </p> <p> You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
8688 "ListSigningCertificates": "<p>Returns information about the signing certificates associated with the specified user. If there are none, the action returns an empty list. </p> <p>Although each user is limited to a small number of signing certificates, you can still paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p>",
87 "ListUserPolicies": "<p>Lists the names of the inline policies embedded in the specified user. </p> <p>A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the action returns an empty list. </p>",
89 "ListUserPolicies": "<p>Lists the names of the inline policies embedded in the specified user. </p> <p>A user can also have managed policies attached to it. To list the managed policies that are attached to a user, use <a>ListAttachedUserPolicies</a>. For more information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. If there are no inline policies embedded with the specified user, the action returns an empty list. </p>",
8890 "ListUsers": "<p>Lists the IAM users that have the specified path prefix. If no path prefix is specified, the action returns all users in the AWS account. If there are none, the action returns an empty list. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
8991 "ListVirtualMFADevices": "<p>Lists the virtual MFA devices under the AWS account by assignment status. If you do not specify an assignment status, the action returns a list of all virtual MFA devices. Assignment status can be <code>Assigned</code>, <code>Unassigned</code>, or <code>Any</code>. </p> <p>You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters. </p>",
90 "PutGroupPolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified group. </p> <p>A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>For information about limits on the number of inline policies that you can embed in a group, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
91 "PutRolePolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified role. </p> <p>When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>. </p> <p>A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>For information about limits on the number of inline policies that you can embed with a role, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
92 "PutUserPolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified user. </p> <p>A user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p> <p>For information about limits on the number of inline policies that you can embed in a user, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
92 "PutGroupPolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified group. </p> <p>A user can also have managed policies attached to it. To attach a managed policy to a group, use <a>AttachGroupPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>For information about limits on the number of inline policies that you can embed in a group, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutGroupPolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
93 "PutRolePolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified role. </p> <p>When you embed an inline policy in a role, the inline policy is used as the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using <a>CreateRole</a>. You can update a role's trust policy using <a>UpdateAssumeRolePolicy</a>. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>. </p> <p>A role can also have a managed policy attached to it. To attach a managed policy to a role, use <a>AttachRolePolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>For information about limits on the number of inline policies that you can embed with a role, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutRolePolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
94 "PutUserPolicy": "<p>Adds (or updates) an inline policy document that is embedded in the specified user. </p> <p>A user can also have a managed policy attached to it. To attach a managed policy to a user, use <a>AttachUserPolicy</a>. To create a new managed policy, use <a>CreatePolicy</a>. For information about policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p> <p>For information about limits on the number of inline policies that you can embed in a user, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <note>Because policy documents can be large, you should use POST rather than GET when calling <code>PutUserPolicy</code>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
9395 "RemoveClientIDFromOpenIDConnectProvider": "<p>Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect provider.</p> <p>This action is idempotent; it does not fail or return an error if you try to remove a client ID that was removed previously.</p>",
9496 "RemoveRoleFromInstanceProfile": "<p>Removes the specified role from the specified instance profile.</p> <important> Make sure you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance will break any applications running on the instance. </important> <p> For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html\">Working with Roles</a>. For more information about instance profiles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/AboutInstanceProfiles.html\">About Instance Profiles</a>. </p>",
9597 "RemoveUserFromGroup": "<p>Removes the specified user from the specified group.</p>",
9698 "ResyncMFADevice": "<p>Synchronizes the specified MFA device with AWS servers.</p> <p>For more information about creating and working with virtual MFA devices, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html\">Using a Virtual MFA Device</a> in the <i>Using IAM</i> guide. </p>",
97 "SetDefaultPolicyVersion": "<p>Sets the specified version of the specified policy as the policy's default (operative) version. </p> <p>This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. </p> <p>For information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
98 "UpdateAccessKey": "<p>Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow. </p> <p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <p>For information about rotating keys, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html\">Managing Keys and Certificates</a> in the <i>Using IAM</i> guide. </p>",
99 "UpdateAccountPasswordPolicy": "<p>Updates the password policy settings for the AWS account.</p> <note> <p>This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </p> </note> <p> For more information about using a password policy, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an IAM Password Policy</a> in the <i>Using IAM</i> guide. </p>",
99 "SetDefaultPolicyVersion": "<p>Sets the specified version of the specified policy as the policy's default (operative) version. </p> <p>This action affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the <a>ListEntitiesForPolicy</a> API. </p> <p>For information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>IAM User Guide</i>. </p>",
100 "SimulateCustomPolicy": "<p>Simulate a set of IAM policies against a list of API actions and AWS resources to determine the policies' effective permissions. The policies are provided as a list of strings.</p> <p>The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.</p> <p>If you want to simulate existing policies attached to an IAM user, group, or role, use <a>SimulatePrincipalPolicy</a> instead.</p> <p>Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. To get the list of context keys required by the policies to simulate them correctly, use <a>GetContextKeysForCustomPolicy</a>.</p> <p>If the output is long, you can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>",
101 "SimulatePrincipalPolicy": "<p>Simulate the set of IAM policies attached to an IAM entity against a list of API actions and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies attached to groups that the user is a member of.</p> <p>You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use <a>SimulateCustomPolicy</a> instead.</p> <p>The simulation does not perform the API actions, it only checks the authorization to determine if the simulated policies allow or deny the actions.</p> <p><b>Note:</b> This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use <a>SimulateCustomPolicy</a> instead.</p> <p>Context keys are variables maintained by AWS and its services that provide details about the context of an API query request, and can be evaluated by using the <code>Condition</code> element of an IAM policy. To get the list of context keys required by the policies to simulate them correctly, use <a>GetContextKeysForPrincipalPolicy</a>.</p> <p>If the output is long, you can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>",
102 "UpdateAccessKey": "<p>Changes the status of the specified access key from Active to Inactive, or vice versa. This action can be used to disable a user's key as part of a key rotation work flow. </p> <p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <p>For information about rotating keys, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html\">Managing Keys and Certificates</a> in the <i>IAM User Guide</i>. </p>",
103 "UpdateAccountPasswordPolicy": "<p>Updates the password policy settings for the AWS account.</p> <note> <p>This action does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the <b>Request Parameters</b> section for each parameter's default value. </p> </note> <p> For more information about using a password policy, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html\">Managing an IAM Password Policy</a> in the <i>IAM User Guide</i>. </p>",
100104 "UpdateAssumeRolePolicy": "<p> Updates the policy that grants an entity permission to assume a role. For more information about roles, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html\">Using Roles to Delegate Permissions and Federate Identities</a>. </p>",
101 "UpdateGroup": "<p>Updates the name and/or the path of the specified group.</p> <important> You should understand the implications of changing a group's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>Using IAM</i> guide. </important> <note>To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
102 "UpdateLoginProfile": "<p>Changes the password for the specified user.</p> <p>Users can change their own passwords by calling <a>ChangePassword</a>. For more information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>Using IAM</i> guide. </p>",
105 "UpdateGroup": "<p>Updates the name and/or the path of the specified group.</p> <important> You should understand the implications of changing a group's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note>To change a group name the requester must have appropriate permissions on both the source object and the target object. For example, to change Managers to MGRs, the entity making the request must have permission on Managers and MGRs, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
106 "UpdateLoginProfile": "<p>Changes the password for the specified user.</p> <p>Users can change their own passwords by calling <a>ChangePassword</a>. For more information about modifying passwords, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html\">Managing Passwords</a> in the <i>IAM User Guide</i>. </p>",
103107 "UpdateOpenIDConnectProviderThumbprint": "<p>Replaces the existing list of server certificate thumbprints with a new list. </p> <p>The list that you pass with this action completely replaces the existing list of thumbprints. (The lists are not merged.)</p> <p>Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate <i>does</i> change, any attempt to assume an IAM role that specifies the OIDC provider as a principal will fail until the certificate thumbprint is updated.</p> <note>Because trust for the OpenID Connect provider is ultimately derived from the provider's certificate and is validated by the thumbprint, it is a best practice to limit access to the <code>UpdateOpenIDConnectProviderThumbprint</code> action to highly-privileged users. </note>",
104108 "UpdateSAMLProvider": "<p>Updates the metadata document for an existing SAML provider.</p> <note>This operation requires <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. </note>",
105109 "UpdateSSHPublicKey": "<p>Sets the status of the specified SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This action can be used to disable a user's SSH public key as part of a key rotation work flow. </p> <p>The SSH public key affected by this action is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
106 "UpdateServerCertificate": "<p>Updates the name and/or the path of the specified server certificate.</p> <important> You should understand the implications of changing a server certificate's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html\">Managing Server Certificates</a> in the <i>Using IAM</i> guide. </important> <note>To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
110 "UpdateServerCertificate": "<p>Updates the name and/or the path of the specified server certificate.</p> <important> You should understand the implications of changing a server certificate's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html\">Managing Server Certificates</a> in the <i>IAM User Guide</i>. </important> <note>To change a server certificate name the requester must have appropriate permissions on both the source object and the target object. For example, to change the name from ProductionCert to ProdCert, the entity making the request must have permission on ProductionCert and ProdCert, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
107111 "UpdateSigningCertificate": "<p>Changes the status of the specified signing certificate from active to disabled, or vice versa. This action can be used to disable a user's signing certificate as part of a certificate rotation work flow. </p> <p>If the <code>UserName</code> field is not specified, the UserName is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p>",
108 "UpdateUser": "<p>Updates the name and/or the path of the specified user.</p> <important> You should understand the implications of changing a user's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>Using IAM</i> guide. </important> <note> To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
112 "UpdateUser": "<p>Updates the name and/or the path of the specified user.</p> <important> You should understand the implications of changing a user's path or name. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html\">Renaming Users and Groups</a> in the <i>IAM User Guide</i>. </important> <note> To change a user name the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/PermissionsAndPolicies.html\" target=\"blank\">Permissions and Policies</a>. </note>",
109113 "UploadSSHPublicKey": "<p>Uploads an SSH public key and associates it with the specified IAM user.</p> <p>The SSH public key uploaded by this action can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see <a href=\"http://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-credentials-ssh.html\">Set up AWS CodeCommit for SSH Connections</a> in the <i>AWS CodeCommit User Guide</i>.</p>",
110 "UploadServerCertificate": "<p>Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. </p> <p>For information about the number of server certificates you can upload, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>Using IAM</i> guide. </p> <note>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. </note>",
114 "UploadServerCertificate": "<p>Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded. </p> <p>For information about the number of server certificates you can upload, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html\">Limitations on IAM Entities</a> in the <i>IAM User Guide</i>. </p> <note>Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling <code>UploadServerCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>IAM User Guide</i>. </note>",
111115 "UploadSigningCertificate": "<p>Uploads an X.509 signing certificate and associates it with the specified user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is <code>Active</code>. </p> <p>If the <code>UserName</code> field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. Because this action works for access keys under the AWS account, you can use this action to manage root credentials even if the AWS account has no associated users. </p> <note>Because the body of a X.509 certificate can be large, you should use POST rather than GET when calling <code>UploadSigningCertificate</code>. For information about setting up signatures and authorization through the API, go to <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a> in the <i>AWS General Reference</i>. For general information about using the Query API with IAM, go to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i>guide. </note>"
112116 },
113 "service": "<fullname>AWS Identity and Access Management</fullname> <p>AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see <a href=\"http://aws.amazon.com/iam/\">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/\">Using IAM</a>. </p> <note>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a> page. </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request. </p> <p> <b>Signing Requests</b> </p> <p>Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests. </p> <p>To sign requests, we recommend that you use <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement. </p> <p> <b>Additional Resources</b> </p> <p>For more information, see the following:</p> <ul> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a>. This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html\">IAM Best Practices</a>. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources. </li> <li> <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/\">AWS Security Token Service</a>. This guide describes how to create and use temporary security credentials. </li> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a>. This set of topics walk you through the process of signing a request using an access key ID and secret access key. </li> </ul>",
117 "service": "<fullname>AWS Identity and Access Management</fullname> <p>AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see <a href=\"http://aws.amazon.com/iam/\">AWS Identity and Access Management (IAM)</a>. For the user guide for IAM, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/\">Using IAM</a>. </p> <note>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a> page. </note> <p>We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html\">Making Query Requests</a> in the <i>Using IAM</i> guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request. </p> <p> <b>Signing Requests</b> </p> <p>Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests. </p> <p>To sign requests, we recommend that you use <a href=\"http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement. </p> <p> <b>Additional Resources</b> </p> <p>For more information, see the following:</p> <ul> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html\">AWS Security Credentials</a>. This topic provides general information about the types of credentials used for accessing AWS. </li> <li> <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html\">IAM Best Practices</a>. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources. </li> <li> <a href=\"http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html\">Signing AWS API Requests</a>. This set of topics walk you through the process of signing a request using an access key ID and secret access key. </li> </ul>",
114118 "shapes": {
115119 "AccessKey": {
116120 "base": "<p>Contains information about an AWS access key.</p> <p> This data type is used as a response element in the <a>CreateAccessKey</a> and <a>ListAccessKeys</a> actions. </p> <note>The <code>SecretAccessKey</code> value is returned only in response to <a>CreateAccessKey</a>. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key. </note>",
130134 "accessKeyMetadataListType$member": null
131135 }
132136 },
137 "ActionNameListType": {
138 "base": null,
139 "refs": {
140 "SimulateCustomPolicyRequest$ActionNames": "<p>A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as <code>iam:CreateUser</code>.</p>",
141 "SimulatePrincipalPolicyRequest$ActionNames": "<p>A list of names of API actions to evaluate in the simulation. Each action is evaluated for each resource. Each action must include the service identifier, such as <code>iam:CreateUser</code>.</p>"
142 }
143 },
144 "ActionNameType": {
145 "base": null,
146 "refs": {
147 "ActionNameListType$member": null,
148 "EvaluationResult$EvalActionName": "<p>The name of the API action tested on the indicated resource.</p>"
149 }
150 },
133151 "AddClientIDToOpenIDConnectProviderRequest": {
134152 "base": null,
135153 "refs": {
178196 "refs": {
179197 }
180198 },
199 "ColumnNumber": {
200 "base": null,
201 "refs": {
202 "Position$Column": "<p>The column in the line containing the specified position in the document.</p>"
203 }
204 },
205 "ContextEntry": {
206 "base": "<p>Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the <code>Condition</code> elements of the input policies.</p> <p>This data type is used as an input parameter to <code><a>SimulatePolicy</a></code>.</p>",
207 "refs": {
208 "ContextEntryListType$member": null
209 }
210 },
211 "ContextEntryListType": {
212 "base": null,
213 "refs": {
214 "SimulateCustomPolicyRequest$ContextEntries": "<p>A list of context keys and corresponding values that are used by the simulation. Whenever a context key is evaluated by a <code>Condition</code> element in one of the simulated IAM permission policies, the corresponding value is supplied.</p>",
215 "SimulatePrincipalPolicyRequest$ContextEntries": "<p>A list of context keys and corresponding values that are used by the simulation. Whenever a context key is evaluated by a <code>Condition</code> element in one of the simulated IAM permission policies, the corresponding value is supplied.</p>"
216 }
217 },
218 "ContextKeyNameType": {
219 "base": null,
220 "refs": {
221 "ContextEntry$ContextKeyName": "<p>The full name of a condition context key, including the service prefix. For example, <code>aws:SourceIp</code> or <code>s3:VersionId</code>.</p>",
222 "ContextKeyNamesResultListType$member": null
223 }
224 },
225 "ContextKeyNamesResultListType": {
226 "base": null,
227 "refs": {
228 "EvaluationResult$MissingContextValues": "<p>A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. To discover the context keys used by a set of policies, you can call <a>GetContextKeysForCustomPolicy</a> or <a>GetContextKeysForPrincipalPolicy</a>.</p> <caution> <p>If the response includes any keys in this list, then the reported results might be untrustworthy because the simulation could not completely evaluate all of the conditions specified in the policies that would occur in a real world request.</p> </caution>",
229 "GetContextKeysForPolicyResponse$ContextKeyNames": "<p>The list of context keys that are used in the <code>Condition</code> elements of the input policies.</p>"
230 }
231 },
232 "ContextKeyTypeEnum": {
233 "base": null,
234 "refs": {
235 "ContextEntry$ContextKeyType": "<p>The data type of the value (or values) specified in the <code>ContextKeyValues</code> parameter.</p>"
236 }
237 },
238 "ContextKeyValueListType": {
239 "base": null,
240 "refs": {
241 "ContextEntry$ContextKeyValues": "<p>The value (or values, if the condition context key supports multiple values) to provide to the simulation for use when the key is referenced by a <code>Condition</code> element in an input policy.</p>"
242 }
243 },
244 "ContextKeyValueType": {
245 "base": null,
246 "refs": {
247 "ContextKeyValueListType$member": null
248 }
249 },
181250 "CreateAccessKeyRequest": {
182251 "base": null,
183252 "refs": {
294363 }
295364 },
296365 "CredentialReportExpiredException": {
297 "base": "<p>The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>Using IAM</i> guide.</p>",
366 "base": "<p>The request was rejected because the most recent credential report has expired. To generate a new credential report, use <a>GenerateCredentialReport</a>. For more information about credential report expiration, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html\">Getting Credential Reports</a> in the <i>IAM User Guide</i>.</p>",
298367 "refs": {
299368 }
300369 },
455524 "entityListType$member": null
456525 }
457526 },
527 "EvaluationResult": {
528 "base": "<p>Contains the results of a simulation.</p> <p>This data type is used by the return parameter of <code><a>SimulatePolicy</a></code>.</p>",
529 "refs": {
530 "EvaluationResultsListType$member": null
531 }
532 },
533 "EvaluationResultsListType": {
534 "base": null,
535 "refs": {
536 "SimulatePolicyResponse$EvaluationResults": "<p>The results of the simulation.</p>"
537 }
538 },
458539 "GenerateCredentialReportResponse": {
459540 "base": "<p>Contains the response to a successful <a>GenerateCredentialReport</a> request. </p>",
460541 "refs": {
487568 },
488569 "GetAccountSummaryResponse": {
489570 "base": "<p>Contains the response to a successful <a>GetAccountSummary</a> request. </p>",
571 "refs": {
572 }
573 },
574 "GetContextKeysForCustomPolicyRequest": {
575 "base": null,
576 "refs": {
577 }
578 },
579 "GetContextKeysForPolicyResponse": {
580 "base": "<p>Contains the response to a successful <a>GetContextKeysForPrincipalPolicy</a> or <a>GetContextKeysForCustomPolicy</a> request. </p>",
581 "refs": {
582 }
583 },
584 "GetContextKeysForPrincipalPolicyRequest": {
585 "base": null,
490586 "refs": {
491587 }
492588 },
692788 "refs": {
693789 }
694790 },
791 "LineNumber": {
792 "base": null,
793 "refs": {
794 "Position$Line": "<p>The line containing the specified position in the document.</p>"
795 }
796 },
695797 "ListAccessKeysRequest": {
696798 "base": null,
697799 "refs": {
10161118 "policyDetailListType$member": null
10171119 }
10181120 },
1121 "PolicyEvaluationDecisionType": {
1122 "base": null,
1123 "refs": {
1124 "EvaluationResult$EvalDecision": "<p>The result of the simulation.</p>"
1125 }
1126 },
1127 "PolicyEvaluationException": {
1128 "base": "<p>The request failed because a provided policy could not be successfully evaluated. An additional detail message indicates the source of the failure.</p>",
1129 "refs": {
1130 }
1131 },
10191132 "PolicyGroup": {
10201133 "base": "<p>Contains information about a group that a managed policy is attached to.</p> <p>This data type is used as a response element in the <a>ListEntitiesForPolicy</a> action. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
10211134 "refs": {
10281141 "ListEntitiesForPolicyResponse$PolicyGroups": "<p>A list of groups that the policy is attached to.</p>"
10291142 }
10301143 },
1144 "PolicyIdentifierType": {
1145 "base": null,
1146 "refs": {
1147 "Statement$SourcePolicyId": "<p>The identifier of the policy that was provided as an input.</p>"
1148 }
1149 },
10311150 "PolicyRole": {
10321151 "base": "<p>Contains information about a role that a managed policy is attached to.</p> <p>This data type is used as a response element in the <a>ListEntitiesForPolicy</a> action. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
10331152 "refs": {
10401159 "ListEntitiesForPolicyResponse$PolicyRoles": "<p>A list of roles that the policy is attached to.</p>"
10411160 }
10421161 },
1162 "PolicySourceType": {
1163 "base": null,
1164 "refs": {
1165 "Statement$SourcePolicyType": "<p>The type of the policy.</p>"
1166 }
1167 },
10431168 "PolicyUser": {
10441169 "base": "<p>Contains information about a user that a managed policy is attached to.</p> <p>This data type is used as a response element in the <a>ListEntitiesForPolicy</a> action. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
10451170 "refs": {
10561181 "base": "<p>Contains information about a version of a managed policy.</p> <p>This data type is used as a response element in the <a>CreatePolicyVersion</a>, <a>GetPolicyVersion</a>, <a>ListPolicyVersions</a>, and <a>GetAccountAuthorizationDetails</a> actions. </p> <p>For more information about managed policies, refer to <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html\">Managed Policies and Inline Policies</a> in the <i>Using IAM</i> guide. </p>",
10571182 "refs": {
10581183 "CreatePolicyVersionResponse$PolicyVersion": "<p>Information about the policy version.</p>",
1059 "GetPolicyVersionResponse$PolicyVersion": "<p>Information about the policy version.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
1184 "GetPolicyVersionResponse$PolicyVersion": "<p>Information about the policy version.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
10601185 "policyDocumentVersionListType$member": null
10611186 }
10621187 },
1188 "Position": {
1189 "base": "<p>Contains the row and column of a location of a <code>Statement</code> element in a policy document.</p> <p>This data type is used as a member of the <code><a>Statement</a></code> type.</p>",
1190 "refs": {
1191 "Statement$StartPosition": "<p>The row and column of the beginning of the <code>Statement</code> in an IAM policy.</p>",
1192 "Statement$EndPosition": "<p>The row and column of the end of a <code>Statement</code> in an IAM policy.</p>"
1193 }
1194 },
10631195 "PutGroupPolicyRequest": {
10641196 "base": null,
10651197 "refs": {
11121244 "base": null,
11131245 "refs": {
11141246 "GenerateCredentialReportResponse$State": "<p>Information about the state of the credential report.</p>"
1247 }
1248 },
1249 "ResourceNameListType": {
1250 "base": null,
1251 "refs": {
1252 "SimulateCustomPolicyRequest$ResourceArns": "<p>A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to <code>*</code> (all resources). Each API in the <code>ActionNames</code> parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.</p>",
1253 "SimulatePrincipalPolicyRequest$ResourceArns": "<p>A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided then the value defaults to <code>*</code> (all resources). Each API in the <code>ActionNames</code> parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.</p>"
1254 }
1255 },
1256 "ResourceNameType": {
1257 "base": null,
1258 "refs": {
1259 "EvaluationResult$EvalResourceName": "<p>The ARN of the resource that the indicated API action was tested on.</p>",
1260 "ResourceNameListType$member": null
11151261 }
11161262 },
11171263 "ResyncMFADeviceRequest": {
11361282 "SAMLMetadataDocumentType": {
11371283 "base": null,
11381284 "refs": {
1139 "CreateSAMLProviderRequest$SAMLMetadataDocument": "<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html\">Creating Temporary Security Credentials for SAML Federation</a> in the <i>Using Temporary Security Credentials</i> guide. </p>",
1285 "CreateSAMLProviderRequest$SAMLMetadataDocument": "<p>An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html\">About SAML 2.0-based Federation</a> in the <i>IAM User Guide</i></p>",
11401286 "GetSAMLProviderResponse$SAMLMetadataDocument": "<p>The XML metadata document that includes information about an identity provider.</p>",
11411287 "UpdateSAMLProviderRequest$SAMLMetadataDocument": "<p> An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP. </p>"
11421288 }
12071353 "refs": {
12081354 "UploadSigningCertificateResponse$Certificate": "<p>Information about the certificate.</p>",
12091355 "certificateListType$member": null
1356 }
1357 },
1358 "SimulateCustomPolicyRequest": {
1359 "base": null,
1360 "refs": {
1361 }
1362 },
1363 "SimulatePolicyResponse": {
1364 "base": "<p>Contains the response to a successful <a>SimulatePrincipalPolicy</a> or <a>SimulateCustomPolicy</a> request.</p>",
1365 "refs": {
1366 }
1367 },
1368 "SimulatePrincipalPolicyRequest": {
1369 "base": null,
1370 "refs": {
1371 }
1372 },
1373 "SimulationPolicyListType": {
1374 "base": null,
1375 "refs": {
1376 "GetContextKeysForCustomPolicyRequest$PolicyInputList": "<p>A list of policies for which you want list of context keys used in <code>Condition</code> elements.</p>",
1377 "GetContextKeysForPrincipalPolicyRequest$PolicyInputList": "<p>A optional list of additional policies for which you want list of context keys used in <code>Condition</code> elements.</p>",
1378 "SimulateCustomPolicyRequest$PolicyInputList": "<p>A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p>",
1379 "SimulatePrincipalPolicyRequest$PolicyInputList": "<p>An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.</p>"
1380 }
1381 },
1382 "Statement": {
1383 "base": "<p>Contains a reference to a <code>Statement</code> element in a policy document that determines the result of the simulation.</p> <p>This data type is used by the <code>MatchedStatements</code> member of the <code><a>EvaluationResult</a></code> type.</p>",
1384 "refs": {
1385 "StatementListType$member": null
1386 }
1387 },
1388 "StatementListType": {
1389 "base": null,
1390 "refs": {
1391 "EvaluationResult$MatchedStatements": "<p>A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the action on the resource, if only one statement denies that action, then the explicit deny overrides any allow, and the deny statement is the only entry included in the result.</p>"
12101392 }
12111393 },
12121394 "UnrecognizedPublicKeyEncodingException": {
13801562 "DetachGroupPolicyRequest$PolicyArn": null,
13811563 "DetachRolePolicyRequest$PolicyArn": null,
13821564 "DetachUserPolicyRequest$PolicyArn": null,
1565 "GetContextKeysForPrincipalPolicyRequest$PolicySourceArn": "<p>The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies attached to the user as well as to all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.</p>",
13831566 "GetOpenIDConnectProviderRequest$OpenIDConnectProviderArn": "<p>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to get information for. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action.</p>",
13841567 "GetPolicyRequest$PolicyArn": null,
13851568 "GetPolicyVersionRequest$PolicyArn": null,
13981581 "SAMLProviderListEntry$Arn": "<p>The Amazon Resource Name (ARN) of the SAML provider.</p>",
13991582 "ServerCertificateMetadata$Arn": "<p> The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>Using IAM</i> guide. </p>",
14001583 "SetDefaultPolicyVersionRequest$PolicyArn": null,
1584 "SimulatePrincipalPolicyRequest$PolicySourceArn": "<p>The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies associated with that entity. If you specify a user, the simulation also includes all policies attached to any groups the user is a member of.</p>",
14011585 "UpdateOpenIDConnectProviderThumbprintRequest$OpenIDConnectProviderArn": "<p>The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider to update the thumbprint for. You can get a list of OIDC provider ARNs by using the <a>ListOpenIDConnectProviders</a> action. </p>",
14021586 "UpdateSAMLProviderRequest$SAMLProviderArn": "<p>The Amazon Resource Name (ARN) of the SAML provider to update.</p>",
14031587 "UpdateSAMLProviderResponse$SAMLProviderArn": "<p>The Amazon Resource Name (ARN) of the SAML provider that was updated.</p>",
14501634 "base": null,
14511635 "refs": {
14521636 "CreateLoginProfileRequest$PasswordResetRequired": "<p> Specifies whether the user is required to set a new password on next sign-in. </p>",
1453 "CreatePolicyVersionRequest$SetAsDefault": "<p>Specifies whether to set this version as the policy's default version.</p> <p>When this parameter is <code>true</code>, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
1454 "GetAccountAuthorizationDetailsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1455 "GetGroupResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1456 "ListAccessKeysResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1457 "ListAccountAliasesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1458 "ListAttachedGroupPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1459 "ListAttachedRolePoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1460 "ListAttachedUserPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1461 "ListEntitiesForPolicyResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1462 "ListGroupPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1463 "ListGroupsForUserResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1464 "ListGroupsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1465 "ListInstanceProfilesForRoleResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1466 "ListInstanceProfilesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1467 "ListMFADevicesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1637 "CreatePolicyVersionRequest$SetAsDefault": "<p>Specifies whether to set this version as the policy's default version.</p> <p>When this parameter is <code>true</code>, the new policy version becomes the operative version; that is, the version that is in effect for the IAM users, groups, and roles that the policy is attached to.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
1638 "GetAccountAuthorizationDetailsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1639 "GetGroupResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1640 "ListAccessKeysResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1641 "ListAccountAliasesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1642 "ListAttachedGroupPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1643 "ListAttachedRolePoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1644 "ListAttachedUserPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1645 "ListEntitiesForPolicyResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1646 "ListGroupPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1647 "ListGroupsForUserResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1648 "ListGroupsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1649 "ListInstanceProfilesForRoleResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1650 "ListInstanceProfilesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1651 "ListMFADevicesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
14681652 "ListPoliciesRequest$OnlyAttached": "<p>A flag to filter the results to only the attached policies. </p> <p>When <code>OnlyAttached</code> is <code>true</code>, the returned list contains only the policies that are attached to a user, group, or role. When <code>OnlyAttached</code> is <code>false</code>, or when the parameter is not included, all policies are returned.</p>",
1469 "ListPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1470 "ListPolicyVersionsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1471 "ListRolePoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1472 "ListRolesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1473 "ListSSHPublicKeysResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1474 "ListServerCertificatesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1475 "ListSigningCertificatesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1476 "ListUserPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1477 "ListUsersResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1478 "ListVirtualMFADevicesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items.</p>",
1653 "ListPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1654 "ListPolicyVersionsResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1655 "ListRolePoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1656 "ListRolesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1657 "ListSSHPublicKeysResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1658 "ListServerCertificatesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1659 "ListSigningCertificatesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1660 "ListUserPoliciesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1661 "ListUsersResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
1662 "ListVirtualMFADevicesResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
14791663 "LoginProfile$PasswordResetRequired": "<p>Specifies whether the user is required to set a new password on next sign-in.</p>",
14801664 "ManagedPolicyDetail$IsAttachable": "<p>Specifies whether the policy can be attached to an IAM user, group, or role. </p>",
14811665 "PasswordPolicy$RequireSymbols": "<p>Specifies whether to require symbols for IAM user passwords.</p>",
14861670 "PasswordPolicy$ExpirePasswords": "<p>Specifies whether IAM users are required to change their password after a specified number of days.</p>",
14871671 "Policy$IsAttachable": "<p>Specifies whether the policy can be attached to an IAM user, group, or role. </p>",
14881672 "PolicyVersion$IsDefaultVersion": "<p>Specifies whether the policy version is set as the policy's default version.</p>",
1673 "SimulatePolicyResponse$IsTruncated": "<p>A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the <code>Marker</code> request parameter to retrieve more items. Note that IAM might return fewer than the <code>MaxItems</code> number of results even when there are more results available. We recommend that you check <code>IsTruncated</code> after every call to ensure that you receive all of your results.</p>",
14891674 "UpdateAccountPasswordPolicyRequest$RequireSymbols": "<p>Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:</p> <p>! @ # $ % ^ &amp;amp; * ( ) _ + - = [ ] { } | '</p> <p>Default value: false</p>",
14901675 "UpdateAccountPasswordPolicyRequest$RequireNumbers": "<p>Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).</p> <p>Default value: false</p>",
14911676 "UpdateAccountPasswordPolicyRequest$RequireUppercaseCharacters": "<p>Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).</p> <p>Default value: false</p>",
14921677 "UpdateAccountPasswordPolicyRequest$RequireLowercaseCharacters": "<p>Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).</p> <p>Default value: false</p>",
1493 "UpdateAccountPasswordPolicyRequest$AllowUsersToChangePassword": "<p> Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html\">Letting IAM Users Change Their Own Passwords</a> in the <i>Using IAM</i> guide. </p> <p>Default value: false</p>"
1678 "UpdateAccountPasswordPolicyRequest$AllowUsersToChangePassword": "<p> Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html\">Letting IAM Users Change Their Own Passwords</a> in the <i>IAM User Guide</i>. </p> <p>Default value: false</p>"
14941679 }
14951680 },
14961681 "certificateBodyType": {
17961981 "markerType": {
17971982 "base": null,
17981983 "refs": {
1799 "GetAccountAuthorizationDetailsRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1984 "GetAccountAuthorizationDetailsRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18001985 "GetAccountAuthorizationDetailsResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1801 "GetGroupRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1986 "GetGroupRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18021987 "GetGroupResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1803 "ListAccessKeysRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1988 "ListAccessKeysRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18041989 "ListAccessKeysResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1805 "ListAccountAliasesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1990 "ListAccountAliasesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18061991 "ListAccountAliasesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1807 "ListAttachedGroupPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1992 "ListAttachedGroupPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18081993 "ListAttachedGroupPoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1809 "ListAttachedRolePoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1994 "ListAttachedRolePoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18101995 "ListAttachedRolePoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1811 "ListAttachedUserPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1996 "ListAttachedUserPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18121997 "ListAttachedUserPoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1813 "ListEntitiesForPolicyRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1998 "ListEntitiesForPolicyRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18141999 "ListEntitiesForPolicyResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1815 "ListGroupPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2000 "ListGroupPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18162001 "ListGroupPoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1817 "ListGroupsForUserRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2002 "ListGroupsForUserRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18182003 "ListGroupsForUserResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1819 "ListGroupsRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2004 "ListGroupsRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18202005 "ListGroupsResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1821 "ListInstanceProfilesForRoleRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2006 "ListInstanceProfilesForRoleRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18222007 "ListInstanceProfilesForRoleResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1823 "ListInstanceProfilesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2008 "ListInstanceProfilesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18242009 "ListInstanceProfilesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1825 "ListMFADevicesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2010 "ListMFADevicesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18262011 "ListMFADevicesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1827 "ListPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2012 "ListPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18282013 "ListPoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1829 "ListPolicyVersionsRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2014 "ListPolicyVersionsRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18302015 "ListPolicyVersionsResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1831 "ListRolePoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2016 "ListRolePoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18322017 "ListRolePoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1833 "ListRolesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2018 "ListRolesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18342019 "ListRolesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1835 "ListSSHPublicKeysRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2020 "ListSSHPublicKeysRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18362021 "ListSSHPublicKeysResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1837 "ListServerCertificatesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2022 "ListServerCertificatesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18382023 "ListServerCertificatesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1839 "ListSigningCertificatesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2024 "ListSigningCertificatesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18402025 "ListSigningCertificatesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1841 "ListUserPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2026 "ListUserPoliciesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18422027 "ListUserPoliciesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1843 "ListUsersRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
2028 "ListUsersRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
18442029 "ListUsersResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
1845 "ListVirtualMFADevicesRequest$Marker": "<p>Use this parameter only when paginating results and only after you have received a response where the results are truncated. Set it to the value of the <code>Marker</code> element in the response you just received.</p>",
1846 "ListVirtualMFADevicesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>"
2030 "ListVirtualMFADevicesRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
2031 "ListVirtualMFADevicesResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
2032 "SimulateCustomPolicyRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>",
2033 "SimulatePolicyResponse$Marker": "<p>When <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value to use for the <code>Marker</code> parameter in a subsequent pagination request.</p>",
2034 "SimulatePrincipalPolicyRequest$Marker": "<p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response you received to inform the next call about where to start.</p>"
18472035 }
18482036 },
18492037 "maxItemsType": {
18502038 "base": null,
18512039 "refs": {
1852 "GetAccountAuthorizationDetailsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1853 "GetGroupRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1854 "ListAccessKeysRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1855 "ListAccountAliasesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1856 "ListAttachedGroupPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1857 "ListAttachedRolePoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1858 "ListAttachedUserPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1859 "ListEntitiesForPolicyRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1860 "ListGroupPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1861 "ListGroupsForUserRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1862 "ListGroupsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1863 "ListInstanceProfilesForRoleRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1864 "ListInstanceProfilesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1865 "ListMFADevicesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1866 "ListPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1867 "ListPolicyVersionsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1868 "ListRolePoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1869 "ListRolesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1870 "ListSSHPublicKeysRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1871 "ListServerCertificatesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1872 "ListSigningCertificatesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1873 "ListUserPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1874 "ListUsersRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>",
1875 "ListVirtualMFADevicesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100.</p>"
2040 "GetAccountAuthorizationDetailsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2041 "GetGroupRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2042 "ListAccessKeysRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2043 "ListAccountAliasesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2044 "ListAttachedGroupPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2045 "ListAttachedRolePoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2046 "ListAttachedUserPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2047 "ListEntitiesForPolicyRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2048 "ListGroupPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2049 "ListGroupsForUserRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2050 "ListGroupsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2051 "ListInstanceProfilesForRoleRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2052 "ListInstanceProfilesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2053 "ListMFADevicesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2054 "ListPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2055 "ListPolicyVersionsRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2056 "ListRolePoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2057 "ListRolesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2058 "ListSSHPublicKeysRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2059 "ListServerCertificatesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2060 "ListSigningCertificatesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2061 "ListUserPoliciesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2062 "ListUsersRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2063 "ListVirtualMFADevicesRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2064 "SimulateCustomPolicyRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>",
2065 "SimulatePrincipalPolicyRequest$MaxItems": "<p>Use this only when paginating results to indicate the maximum number of items you want in the response. If there are additional items beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>This parameter is optional. If you do not include it, it defaults to 100. Note that IAM might return fewer results, even when there are more results available. If this is the case, the <code>IsTruncated</code> response element returns <code>true</code> and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from. </p>"
18762066 }
18772067 },
18782068 "maxPasswordAgeType": {
19882178 "PutUserPolicyRequest$PolicyDocument": "<p>The policy document.</p>",
19892179 "Role$AssumeRolePolicyDocument": "<p>The policy that grants an entity permission to assume the role.</p>",
19902180 "RoleDetail$AssumeRolePolicyDocument": "<p>The trust policy that grants permission to assume the role.</p>",
2181 "SimulationPolicyListType$member": null,
19912182 "UpdateAssumeRolePolicyRequest$PolicyDocument": "<p>The policy that grants an entity permission to assume the role.</p>"
19922183 }
19932184 },
19942185 "policyDocumentVersionListType": {
19952186 "base": null,
19962187 "refs": {
1997 "ListPolicyVersionsResponse$Versions": "<p>A list of policy versions.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
2188 "ListPolicyVersionsResponse$Versions": "<p>A list of policy versions.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
19982189 "ManagedPolicyDetail$PolicyVersionList": "<p>A list containing information about the versions of the policy.</p>"
2190 }
2191 },
2192 "policyEvaluationErrorMessage": {
2193 "base": null,
2194 "refs": {
2195 "PolicyEvaluationException$message": null
19992196 }
20002197 },
20012198 "policyListType": {
20382235 "policyPathType": {
20392236 "base": null,
20402237 "refs": {
2041 "CreatePolicyRequest$Path": "<p>The path for the policy. </p> <p>For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>Using IAM</i> guide. </p> <p>This parameter is optional. If it is not included, it defaults to a slash (/). </p>",
2238 "CreatePolicyRequest$Path": "<p>The path for the policy. </p> <p>For more information about paths, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html\">IAM Identifiers</a> in the <i>IAM User Guide</i>. </p> <p>This parameter is optional. If it is not included, it defaults to a slash (/). </p>",
20422239 "ListAttachedGroupPoliciesRequest$PathPrefix": "<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p>",
20432240 "ListAttachedRolePoliciesRequest$PathPrefix": "<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p>",
20442241 "ListAttachedUserPoliciesRequest$PathPrefix": "<p>The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.</p>",
20562253 "policyVersionIdType": {
20572254 "base": null,
20582255 "refs": {
2059 "DeletePolicyVersionRequest$VersionId": "<p>The policy version to delete.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
2256 "DeletePolicyVersionRequest$VersionId": "<p>The policy version to delete.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>",
20602257 "GetPolicyVersionRequest$VersionId": "<p>Identifies the policy version to retrieve.</p>",
20612258 "ManagedPolicyDetail$DefaultVersionId": "<p>The identifier for the version of the policy that is set as the default (operative) version. </p> <p>For more information about policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>",
20622259 "Policy$DefaultVersionId": "<p>The identifier for the version of the policy that is set as the default version. </p>",
20632260 "PolicyVersion$VersionId": "<p>The identifier for the policy version.</p> <p>Policy version identifiers always begin with <code>v</code> (always lowercase). When a policy is created, the first policy version is <code>v1</code>. </p>",
2064 "SetDefaultPolicyVersionRequest$VersionId": "<p>The version of the policy to set as the default (operative) version.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>Using IAM</i> guide. </p>"
2261 "SetDefaultPolicyVersionRequest$VersionId": "<p>The version of the policy to set as the default (operative) version.</p> <p>For more information about managed policy versions, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html\">Versioning for Managed Policies</a> in the <i>IAM User Guide</i>. </p>"
20652262 }
20662263 },
20672264 "privateKeyType": {
22042401 "thumbprintListType": {
22052402 "base": "<p>Contains a list of thumbprints of identity provider server certificates.</p>",
22062403 "refs": {
2207 "CreateOpenIDConnectProviderRequest$ThumbprintList": "<p>A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.</p> <p>The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string. </p> <p>You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is <code>server.example.com</code> and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com. </p> <p>For more information about obtaining the OIDC provider's thumbprint, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html\">Obtaining the Thumbprint for an OpenID Connect Provider</a> in the <i>Using IAM</i> guide. </p>",
2404 "CreateOpenIDConnectProviderRequest$ThumbprintList": "<p>A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificate(s). Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.</p> <p>The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string. </p> <p>You must provide at least one thumbprint when creating an IAM OIDC provider. For example, if the OIDC provider is <code>server.example.com</code> and the provider stores its keys at \"https://keys.server.example.com/openid-connect\", the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com. </p> <p>For more information about obtaining the OIDC provider's thumbprint, see <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html\">Obtaining the Thumbprint for an OpenID Connect Provider</a> in the <i>IAM User Guide</i>. </p>",
22082405 "GetOpenIDConnectProviderResponse$ThumbprintList": "<p>A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see <a>CreateOpenIDConnectProvider</a>. </p>",
22092406 "UpdateOpenIDConnectProviderThumbprintRequest$ThumbprintList": "<p>A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see <a>CreateOpenIDConnectProvider</a>. </p>"
22102407 }
+17
-0
apis/iam/2010-05-08/waiters-2.json less more
00 {
11 "version": 2,
22 "waiters": {
3 "InstanceProfileExists": {
4 "delay": 1,
5 "operation": "GetInstanceProfile",
6 "maxAttempts": 40,
7 "acceptors": [
8 {
9 "expected": 200,
10 "matcher": "status",
11 "state": "success"
12 },
13 {
14 "state": "retry",
15 "matcher": "status",
16 "expected": 404
17 }
18 ]
19 },
320 "UserExists": {
421 "delay": 1,
522 "operation": "GetUser",
+5
-2
apis/kinesis/2013-12-02/api-2.json less more
320320 "Tags":{"shape":"TagMap"}
321321 }
322322 },
323 "ApproximateArrivalTimestamp":{"type":"timestamp"},
323324 "BooleanObject":{"type":"boolean"},
324325 "CreateStreamInput":{
325326 "type":"structure",
335336 "Data":{
336337 "type":"blob",
337338 "min":0,
338 "max":51200
339 "max":1048576
339340 },
340341 "DeleteStreamInput":{
341342 "type":"structure",
517518 },
518519 "PositiveIntegerObject":{
519520 "type":"integer",
520 "min":1
521 "min":1,
522 "max":100000
521523 },
522524 "ProvisionedThroughputExceededException":{
523525 "type":"structure",
613615 ],
614616 "members":{
615617 "SequenceNumber":{"shape":"SequenceNumber"},
618 "ApproximateArrivalTimestamp":{"shape":"ApproximateArrivalTimestamp"},
616619 "Data":{"shape":"Data"},
617620 "PartitionKey":{"shape":"PartitionKey"}
618621 }
+16
-10
apis/kinesis/2013-12-02/docs-2.json less more
11 "version": "2.0",
22 "operations": {
33 "AddTagsToStream": "<p>Adds or updates tags for the specified Amazon Kinesis stream. Each stream can have up to 10 tags. </p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p>",
4 "CreateStream": "<p>Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each open shard can support up to 5 read transactions per second, up to a maximum total of 2 MB of data read per second. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </p> <p><code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following:</p> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a></p> <p>You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p><a>CreateStream</a> has a limit of 5 transactions per second per account.</p>",
4 "CreateStream": "<p>Creates a Amazon Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within an Amazon Kinesis stream is explicitly supported by means of shards, which are uniquely identified groups of data records in an Amazon Kinesis stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. You can add shards to a stream if the amount of data input increases and you can remove shards if the amount of data input decreases.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name. </p> <p><code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Amazon Kinesis immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request if you try to do one of the following:</p> <ul> <li>Have more than five streams in the <code>CREATING</code> state at any point in time.</li> <li>Create more shards than are authorized for your account.</li> </ul> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p><a>CreateStream</a> has a limit of 5 transactions per second per account.</p>",
55 "DeleteStream": "<p>Deletes a stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it will receive the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Amazon Kinesis completes the deletion.</p> <p><b>Note:</b> Amazon Kinesis might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p><a>DeleteStream</a> has a limit of 5 transactions per second per account.</p>",
66 "DescribeStream": "<p>Describes the specified stream.</p> <p>The information about the stream includes its current status, its Amazon Resource Name (ARN), and an array of shard objects. For each shard object, there is information about the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream.</p> <p>You can limit the number of returned shards using the <code>Limit</code> parameter. The number of shards in a stream may be too large to return from a single call to <code>DescribeStream</code>. You can detect this by using the <code>HasMoreShards</code> flag in the returned output. <code>HasMoreShards</code> is set to <code>true</code> when there is more data available. </p> <p><code>DescribeStream</code> is a paginated operation. If there are more shards available, you can request them using the shard ID of the last shard returned. Specify this ID in the <code>ExclusiveStartShardId</code> parameter in a subsequent request to <code>DescribeStream</code>. </p> <p><a>DescribeStream</a> has a limit of 10 transactions per second per account.</p>",
7 "GetRecords": "<p>Gets data records from a shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. Note that if the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 50 KB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit. For example, if your average record size is 40 KB, you can limit the data returned to about 1 MB per call by specifying 25 as the limit.</p> <p>The size of the data returned by <a>GetRecords</a> will vary depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. Note that <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the amount of data in a stream using the CloudWatch metrics. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring_with_cloudwatch.html\">Monitoring Amazon Kinesis with Amazon CloudWatch</a> in the <i>Amazon Kinesis Developer Guide</i>.</p>",
7 "GetRecords": "<p>Gets data records from a shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards. Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. Note that if the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit.</p> <p>The size of the data returned by <a>GetRecords</a> will vary depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. Note that <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics (see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html\">Monitoring Amazon Kinesis</a> in the <i>Amazon Kinesis Developer Guide</i>).</p> <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when an Amazon Kinesis stream successfully receives and stores a record. This is commonly referred to as a server-side timestamp, which is different than a client-side timestamp, where the timestamp is set when a data producer creates or sends the record to a stream. The timestamp has millisecond precision. There are no guarantees about the timestamp accuracy, or that the timestamp is always increasing. For example, records in a shard or across a stream might have timestamps that are out of order.</p>",
88 "GetShardIterator": "<p>Gets a shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the Amazon Kinesis stream. The sequence number is assigned when a record is put into the stream. </p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type, or right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. You can specify the shard iterator type <code>TRIM_HORIZON</code> in the request to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system, which is the oldest data record in the shard. Or you can point to just after the most recent record in the shard, by using the shard iterator type <code>LATEST</code>, so that you always read the most recent data in the shard. </p> <p>When you repeatedly read from an Amazon Kinesis stream use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and then use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code> for subsequent reads. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>.</p> <p>If the shard is closed, the iterator can't return more data, and <a>GetShardIterator</a> returns <code>null</code> for its <code>ShardIterator</code>. A shard can be closed using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p><a>GetShardIterator</a> has a limit of 5 transactions per second per account per open shard.</p>",
99 "ListStreams": "<p> Lists your streams.</p> <p> The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Amazon Kinesis uses the default limit, which is currently 10.</p> <p> You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </p> <p><a>ListStreams</a> has a limit of 5 transactions per second per account.</p>",
1010 "ListTagsForStream": "<p>Lists the tags for the specified Amazon Kinesis stream.</p>",
1111 "MergeShards": "<p>Merges two adjacent shards in a stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.</p> <p><code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html\">Merge Two Shards</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p> <p>You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p><code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </p> <p><code>MergeShards</code> has limit of 5 transactions per second per account.</p>",
12 "PutRecord": "<p>Puts (writes) a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </p> <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p><code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.</p> <p>Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
13 "PutRecords": "<p>Puts (writes) multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for real-time ingestion and processing. Each shard can support up to 1000 records written per second, up to a maximum total of 1 MB data written per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. </p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully-processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully-processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
12 "PutRecord": "<p>Writes a single data record from a producer into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data from the producer into the Amazon Kinesis stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis to distribute data across shards. Amazon Kinesis segregates the data records that belong to a data stream into multiple shards, using the partition key associated with each data record to determine which shard a given data record belongs to. </p> <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p><code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.</p> <p>Sequence numbers generally increase over time. To guarantee strictly increasing ordering, use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
13 "PutRecords": "<p>Writes multiple data records from a producer into an Amazon Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data from a data producer into the Amazon Kinesis stream for data ingestion and processing. </p> <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Amazon Kinesis as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully-processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully-processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>Data records are accessible for only 24 hours from the time that they are added to an Amazon Kinesis stream.</p>",
1414 "RemoveTagsFromStream": "<p>Deletes tags from the specified Amazon Kinesis stream.</p> <p>If you specify a tag that does not exist, it is ignored.</p>",
15 "SplitShard": "<p>Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p><code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a></p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p><code>SplitShard</code> has limit of 5 transactions per second per account.</p>"
15 "SplitShard": "<p>Splits a shard into two new shards in the stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization, for example, when the set of producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Amazon Kinesis applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might simply be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information about splitting shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p><code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Amazon Kinesis immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Limits</a>. If you need to increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a> or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p><code>SplitShard</code> has limit of 5 transactions per second per account.</p>"
1616 },
1717 "service": "<fullname>Amazon Kinesis Service API Reference</fullname> <p>Amazon Kinesis is a managed service that scales elastically for real time processing of streaming big data.</p>",
1818 "shapes": {
2121 "refs": {
2222 }
2323 },
24 "ApproximateArrivalTimestamp": {
25 "base": null,
26 "refs": {
27 "Record$ApproximateArrivalTimestamp": "<p>The approximate time that the record was inserted into the stream.</p>"
28 }
29 },
2430 "BooleanObject": {
2531 "base": null,
2632 "refs": {
3743 "Data": {
3844 "base": null,
3945 "refs": {
40 "PutRecordInput$Data": "<p>The data blob to put into the record, which is base64-encoded when the blob is serialized. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB) </p>",
41 "PutRecordsRequestEntry$Data": "<p>The data blob to put into the record, which is base64-encoded when the blob is serialized. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB)</p>",
42 "Record$Data": "<p>The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. The maximum size of the data blob (the payload before base64-encoding) is 50 kilobytes (KB) </p>"
46 "PutRecordInput$Data": "<p>The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB). </p>",
47 "PutRecordsRequestEntry$Data": "<p>The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).</p>",
48 "Record$Data": "<p>The data blob. The data in the blob is both opaque and immutable to the Amazon Kinesis service, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).</p>"
4349 }
4450 },
4551 "DeleteStreamInput": {
254260 "RecordList": {
255261 "base": null,
256262 "refs": {
257 "GetRecordsOutput$Records": "<P>The data records retrieved from the shard.</P>"
263 "GetRecordsOutput$Records": "<p>The data records retrieved from the shard.</p>"
258264 }
259265 },
260266 "RemoveTagsFromStreamInput": {
279285 "PutRecordInput$SequenceNumberForOrdering": "<p>Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the <code>SequenceNumberForOrdering</code> of record <i>n</i> to the sequence number of record <i>n-1</i> (as returned in the result when putting record <i>n-1</i>). If this parameter is not set, records will be coarsely ordered based on arrival time.</p>",
280286 "PutRecordOutput$SequenceNumber": "<p>The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.</p>",
281287 "PutRecordsResultEntry$SequenceNumber": "<p>The sequence number for an individual record result.</p>",
282 "Record$SequenceNumber": "<p>The unique identifier for the record in the Amazon Kinesis stream.</p>",
288 "Record$SequenceNumber": "<p>The unique identifier of the record in the stream.</p>",
283289 "SequenceNumberRange$StartingSequenceNumber": "<p>The starting sequence number for the range.</p>",
284290 "SequenceNumberRange$EndingSequenceNumber": "<p>The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of <code>null</code>.</p>"
285291 }
+196
-0
apis/logs/2014-03-28/api-2.json less more
99 "protocol":"json"
1010 },
1111 "operations":{
12 "CancelExportTask":{
13 "name":"CancelExportTask",
14 "http":{
15 "method":"POST",
16 "requestUri":"/"
17 },
18 "input":{"shape":"CancelExportTaskRequest"},
19 "errors":[
20 {
21 "shape":"InvalidParameterException",
22 "exception":true
23 },
24 {
25 "shape":"ResourceNotFoundException",
26 "exception":true
27 },
28 {
29 "shape":"InvalidOperationException",
30 "exception":true
31 },
32 {
33 "shape":"ServiceUnavailableException",
34 "exception":true,
35 "fault":true
36 }
37 ]
38 },
39 "CreateExportTask":{
40 "name":"CreateExportTask",
41 "http":{
42 "method":"POST",
43 "requestUri":"/"
44 },
45 "input":{"shape":"CreateExportTaskRequest"},
46 "output":{"shape":"CreateExportTaskResponse"},
47 "errors":[
48 {
49 "shape":"InvalidParameterException",
50 "exception":true
51 },
52 {
53 "shape":"LimitExceededException",
54 "exception":true
55 },
56 {
57 "shape":"OperationAbortedException",
58 "exception":true
59 },
60 {
61 "shape":"ServiceUnavailableException",
62 "exception":true,
63 "fault":true
64 },
65 {
66 "shape":"ResourceNotFoundException",
67 "exception":true
68 },
69 {
70 "shape":"ResourceAlreadyExistsException",
71 "exception":true
72 }
73 ]
74 },
1275 "CreateLogGroup":{
1376 "name":"CreateLogGroup",
1477 "http":{
237300 },
238301 "input":{"shape":"DescribeDestinationsRequest"},
239302 "output":{"shape":"DescribeDestinationsResponse"},
303 "errors":[
304 {
305 "shape":"InvalidParameterException",
306 "exception":true
307 },
308 {
309 "shape":"ServiceUnavailableException",
310 "exception":true,
311 "fault":true
312 }
313 ]
314 },
315 "DescribeExportTasks":{
316 "name":"DescribeExportTasks",
317 "http":{
318 "method":"POST",
319 "requestUri":"/"
320 },
321 "input":{"shape":"DescribeExportTasksRequest"},
322 "output":{"shape":"DescribeExportTasksResponse"},
240323 "errors":[
241324 {
242325 "shape":"InvalidParameterException",
588671 "min":1
589672 },
590673 "Arn":{"type":"string"},
674 "CancelExportTaskRequest":{
675 "type":"structure",
676 "required":["taskId"],
677 "members":{
678 "taskId":{"shape":"ExportTaskId"}
679 }
680 },
681 "CreateExportTaskRequest":{
682 "type":"structure",
683 "required":[
684 "logGroupName",
685 "from",
686 "to",
687 "destination"
688 ],
689 "members":{
690 "taskName":{"shape":"ExportTaskName"},
691 "logGroupName":{"shape":"LogGroupName"},
692 "logStreamNamePrefix":{"shape":"LogStreamName"},
693 "from":{"shape":"Timestamp"},
694 "to":{"shape":"Timestamp"},
695 "destination":{"shape":"ExportDestinationBucket"},
696 "destinationPrefix":{"shape":"ExportDestinationPrefix"}
697 }
698 },
699 "CreateExportTaskResponse":{
700 "type":"structure",
701 "members":{
702 "taskId":{"shape":"ExportTaskId"}
703 }
704 },
591705 "CreateLogGroupRequest":{
592706 "type":"structure",
593707 "required":["logGroupName"],
681795 "type":"structure",
682796 "members":{
683797 "destinations":{"shape":"Destinations"},
798 "nextToken":{"shape":"NextToken"}
799 }
800 },
801 "DescribeExportTasksRequest":{
802 "type":"structure",
803 "members":{
804 "taskId":{"shape":"ExportTaskId"},
805 "statusCode":{"shape":"ExportTaskStatusCode"},
806 "nextToken":{"shape":"NextToken"},
807 "limit":{"shape":"DescribeLimit"}
808 }
809 },
810 "DescribeExportTasksResponse":{
811 "type":"structure",
812 "members":{
813 "exportTasks":{"shape":"ExportTasks"},
684814 "nextToken":{"shape":"NextToken"}
685815 }
686816 },
792922 "type":"integer",
793923 "min":1,
794924 "max":10000
925 },
926 "ExportDestinationBucket":{
927 "type":"string",
928 "min":1,
929 "max":512
930 },
931 "ExportDestinationPrefix":{"type":"string"},
932 "ExportTask":{
933 "type":"structure",
934 "members":{
935 "taskId":{"shape":"ExportTaskId"},
936 "taskName":{"shape":"ExportTaskName"},
937 "logGroupName":{"shape":"LogGroupName"},
938 "from":{"shape":"Timestamp"},
939 "to":{"shape":"Timestamp"},
940 "destination":{"shape":"ExportDestinationBucket"},
941 "destinationPrefix":{"shape":"ExportDestinationPrefix"},
942 "status":{"shape":"ExportTaskStatus"},
943 "executionInfo":{"shape":"ExportTaskExecutionInfo"}
944 }
945 },
946 "ExportTaskExecutionInfo":{
947 "type":"structure",
948 "members":{
949 "creationTime":{"shape":"Timestamp"},
950 "completionTime":{"shape":"Timestamp"}
951 }
952 },
953 "ExportTaskId":{
954 "type":"string",
955 "min":1,
956 "max":512
957 },
958 "ExportTaskName":{
959 "type":"string",
960 "min":1,
961 "max":512
962 },
963 "ExportTaskStatus":{
964 "type":"structure",
965 "members":{
966 "code":{"shape":"ExportTaskStatusCode"},
967 "message":{"shape":"ExportTaskStatusMessage"}
968 }
969 },
970 "ExportTaskStatusCode":{
971 "type":"string",
972 "enum":[
973 "CANCELLED",
974 "COMPLETED",
975 "FAILED",
976 "PENDING",
977 "PENDING_CANCEL",
978 "RUNNING"
979 ]
980 },
981 "ExportTaskStatusMessage":{"type":"string"},
982 "ExportTasks":{
983 "type":"list",
984 "member":{"shape":"ExportTask"}
795985 },
796986 "ExtractedValues":{
797987 "type":"map",
8941084 "max":100
8951085 },
8961086 "Interleaved":{"type":"boolean"},
1087 "InvalidOperationException":{
1088 "type":"structure",
1089 "members":{
1090 },
1091 "exception":true
1092 },
8971093 "InvalidParameterException":{
8981094 "type":"structure",
8991095 "members":{
+119
-7
apis/logs/2014-03-28/docs-2.json less more
00 {
11 "version": "2.0",
22 "operations": {
3 "CancelExportTask": "<p> Cancels an export task if it is in <code>PENDING</code> or <code>RUNNING</code> state. </p>",
4 "CreateExportTask": "<p> Creates an <code>ExportTask</code> which allows you to efficiently export data from a Log Group to your Amazon S3 bucket. </p> <p> This is an asynchronous call. If all the required information is provided, this API will initiate an export task and respond with the task Id. Once started, <code>DescribeExportTasks</code> can be used to get the status of an export task. </p>",
35 "CreateLogGroup": "<p> Creates a new log group with the specified name. The name of the log group must be unique within a region for an AWS account. You can create up to 500 log groups per account. </p> <p> You must use the following guidelines when naming a log group: <ul> <li>Log group names can be between 1 and 512 characters long.</li> <li>Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).</li> </ul> </p>",
46 "CreateLogStream": "<p> Creates a new log stream in the specified log group. The name of the log stream must be unique within the log group. There is no limit on the number of log streams that can exist in a log group. </p> <p> You must use the following guidelines when naming a log stream: <ul> <li>Log stream names can be between 1 and 512 characters long.</li> <li>The ':' colon character is not allowed.</li> </ul> </p>",
57 "DeleteDestination": "<p> Deletes the destination with the specified name and eventually disables all the subscription filters that publish to it. This will not delete the physical resource encapsulated by the destination. </p>",
911 "DeleteRetentionPolicy": "<p> Deletes the retention policy of the specified log group. Log events would not expire if they belong to log groups without a retention policy. </p>",
1012 "DeleteSubscriptionFilter": "<p> Deletes a subscription filter associated with the specified log group. </p>",
1113 "DescribeDestinations": "<p> Returns all the destinations that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by destination name. </p> <p> By default, this operation returns up to 50 destinations. If there are more destinations to list, the response would contain a <code class=\"code\">nextToken</code> value in the response body. You can also limit the number of destinations returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. </p>",
14 "DescribeExportTasks": "<p> Returns all the export tasks that are associated with the AWS account making the request. The export tasks can be filtered based on <code>TaskId</code> or <code>TaskStatus</code>. </p> <p> By default, this operation returns up to 50 export tasks that satisfy the specified filters. If there are more export tasks to list, the response would contain a <code class=\"code\">nextToken</code> value in the response body. You can also limit the number of export tasks returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. </p>",
1215 "DescribeLogGroups": "<p> Returns all the log groups that are associated with the AWS account making the request. The list returned in the response is ASCII-sorted by log group name. </p> <p> By default, this operation returns up to 50 log groups. If there are more log groups to list, the response would contain a <code class=\"code\">nextToken</code> value in the response body. You can also limit the number of log groups returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. </p>",
1316 "DescribeLogStreams": "<p> Returns all the log streams that are associated with the specified log group. The list returned in the response is ASCII-sorted by log stream name. </p> <p> By default, this operation returns up to 50 log streams. If there are more log streams to list, the response would contain a <code class=\"code\">nextToken</code> value in the response body. You can also limit the number of log streams returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. This operation has a limit of five transactions per second, after which transactions are throttled. </p>",
1417 "DescribeMetricFilters": "<p> Returns all the metrics filters associated with the specified log group. The list returned in the response is ASCII-sorted by filter name. </p> <p> By default, this operation returns up to 50 metric filters. If there are more metric filters to list, the response would contain a <code class=\"code\">nextToken</code> value in the response body. You can also limit the number of metric filters returned in the response by specifying the <code class=\"code\">limit</code> parameter in the request. </p>",
2831 "AccessPolicy": {
2932 "base": null,
3033 "refs": {
31 "Destination$accessPolicy": null,
34 "Destination$accessPolicy": "<p>An IAM policy document that governs which AWS accounts can create subscription filters against this destination.</p>",
3235 "PutDestinationPolicyRequest$accessPolicy": "<p>An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.</p>"
3336 }
3437 },
3538 "Arn": {
3639 "base": null,
3740 "refs": {
38 "Destination$arn": null,
41 "Destination$arn": "<p>ARN of this destination.</p>",
3942 "LogGroup$arn": null,
4043 "LogStream$arn": null
4144 }
4245 },
46 "CancelExportTaskRequest": {
47 "base": null,
48 "refs": {
49 }
50 },
51 "CreateExportTaskRequest": {
52 "base": null,
53 "refs": {
54 }
55 },
56 "CreateExportTaskResponse": {
57 "base": null,
58 "refs": {
59 }
60 },
4361 "CreateLogGroupRequest": {
4462 "base": null,
4563 "refs": {
108126 "refs": {
109127 }
110128 },
129 "DescribeExportTasksRequest": {
130 "base": null,
131 "refs": {
132 }
133 },
134 "DescribeExportTasksResponse": {
135 "base": null,
136 "refs": {
137 }
138 },
111139 "DescribeLimit": {
112140 "base": "<p>The maximum number of results to return.</p>",
113141 "refs": {
114142 "DescribeDestinationsRequest$limit": null,
143 "DescribeExportTasksRequest$limit": "<p> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </p>",
115144 "DescribeLogGroupsRequest$limit": "<p> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </p>",
116145 "DescribeLogStreamsRequest$limit": "<p> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </p>",
117146 "DescribeMetricFiltersRequest$limit": "<p> The maximum number of items returned in the response. If you don't specify a value, the request would return up to 50 items. </p>",
159188 }
160189 },
161190 "Destination": {
162 "base": null,
191 "base": "<p>A cross account destination that is the recipient of subscription log events.</p>",
163192 "refs": {
164193 "Destinations$member": null,
165194 "PutDestinationResponse$destination": null
177206 "refs": {
178207 "DeleteDestinationRequest$destinationName": "<p>The name of destination to delete.</p>",
179208 "DescribeDestinationsRequest$DestinationNamePrefix": "<p>Will only return destinations that match the provided destinationNamePrefix. If you don't specify a value, no prefix is applied.</p>",
180 "Destination$destinationName": null,
209 "Destination$destinationName": "<p>Name of the destination.</p>",
181210 "PutDestinationPolicyRequest$destinationName": "<p>A name for an existing destination.</p>",
182211 "PutDestinationRequest$destinationName": "<p>A name for the destination.</p>"
183212 }
215244 "refs": {
216245 "FilterLogEventsRequest$limit": "<p>The maximum number of events to return in a page of results. Default is 10,000 events.</p>",
217246 "GetLogEventsRequest$limit": "<p> The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events. </p>"
247 }
248 },
249 "ExportDestinationBucket": {
250 "base": null,
251 "refs": {
252 "CreateExportTaskRequest$destination": "<p>Name of Amazon S3 bucket to which the log data will be exported. <br><b>NOTE: Only buckets in the same AWS region are supported</b></p>",
253 "ExportTask$destination": "<p>Name of Amazon S3 bucket to which the log data was exported.</p>"
254 }
255 },
256 "ExportDestinationPrefix": {
257 "base": null,
258 "refs": {
259 "CreateExportTaskRequest$destinationPrefix": "<p>Prefix that will be used as the start of Amazon S3 key for every object exported. If not specified, this defaults to 'exportedlogs'.</p>",
260 "ExportTask$destinationPrefix": "<p>Prefix that was used as the start of Amazon S3 key for every object exported.</p>"
261 }
262 },
263 "ExportTask": {
264 "base": "<p>Represents an export task.</p>",
265 "refs": {
266 "ExportTasks$member": null
267 }
268 },
269 "ExportTaskExecutionInfo": {
270 "base": "<p>Represents the status of an export task.</p>",
271 "refs": {
272 "ExportTask$executionInfo": "<p>Execution info about the export task.</p>"
273 }
274 },
275 "ExportTaskId": {
276 "base": null,
277 "refs": {
278 "CancelExportTaskRequest$taskId": "<p>Id of the export task to cancel.</p>",
279 "CreateExportTaskResponse$taskId": "<p>Id of the export task that got created.</p>",
280 "DescribeExportTasksRequest$taskId": "<p>Export task that matches the specified task Id will be returned. This can result in zero or one export task.</p>",
281 "ExportTask$taskId": "<p>Id of the export task.</p>"
282 }
283 },
284 "ExportTaskName": {
285 "base": null,
286 "refs": {
287 "CreateExportTaskRequest$taskName": "<p>The name of the export task.</p>",
288 "ExportTask$taskName": "<p>The name of the export task.</p>"
289 }
290 },
291 "ExportTaskStatus": {
292 "base": "<p>Represents the status of an export task.</p>",
293 "refs": {
294 "ExportTask$status": "<p>Status of the export task.</p>"
295 }
296 },
297 "ExportTaskStatusCode": {
298 "base": null,
299 "refs": {
300 "DescribeExportTasksRequest$statusCode": "<p>All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.</p>",
301 "ExportTaskStatus$code": "<p>Status code of the export task.</p>"
302 }
303 },
304 "ExportTaskStatusMessage": {
305 "base": null,
306 "refs": {
307 "ExportTaskStatus$message": "<p>Status message related to the <code class=\"code\">code</code>.</p>"
308 }
309 },
310 "ExportTasks": {
311 "base": "<p>A list of export tasks.</p>",
312 "refs": {
313 "DescribeExportTasksResponse$exportTasks": null
218314 }
219315 },
220316 "ExtractedValues": {
309405 "FilterLogEventsRequest$interleaved": "<p>If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.</p>"
310406 }
311407 },
408 "InvalidOperationException": {
409 "base": "<p>Returned if the operation is not valid on the specified resource</p>",
410 "refs": {
411 }
412 },
312413 "InvalidParameterException": {
313414 "base": "<p>Returned if a parameter of the request is incorrectly specified.</p>",
314415 "refs": {
341442 "LogGroupName": {
342443 "base": null,
343444 "refs": {
445 "CreateExportTaskRequest$logGroupName": "<p>The name of the log group to export.</p>",
344446 "CreateLogGroupRequest$logGroupName": "<p>The name of the log group to create.</p>",
345447 "CreateLogStreamRequest$logGroupName": "<p>The name of the log group under which the log stream is to be created.</p>",
346448 "DeleteLogGroupRequest$logGroupName": "<p>The name of the log group to delete.</p>",
352454 "DescribeLogStreamsRequest$logGroupName": "<p>The log group name for which log streams are to be listed.</p>",
353455 "DescribeMetricFiltersRequest$logGroupName": "<p>The log group name for which metric filters are to be listed.</p>",
354456 "DescribeSubscriptionFiltersRequest$logGroupName": "<p>The log group name for which subscription filters are to be listed.</p>",
457 "ExportTask$logGroupName": "<p>The name of the log group from which logs data was exported.</p>",
355458 "FilterLogEventsRequest$logGroupName": "<p> The name of the log group to query. </p>",
356459 "GetLogEventsRequest$logGroupName": "<p>The name of the log group to query.</p>",
357460 "LogGroup$logGroupName": null,
377480 "LogStreamName": {
378481 "base": null,
379482 "refs": {
483 "CreateExportTaskRequest$logStreamNamePrefix": "<p>Will only export log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied.</p>",
380484 "CreateLogStreamRequest$logStreamName": "<p>The name of the log stream to create.</p>",
381485 "DeleteLogStreamRequest$logStreamName": "<p>The name of the log stream to delete.</p>",
382486 "DescribeLogStreamsRequest$logStreamNamePrefix": "<p> Will only return log streams that match the provided logStreamNamePrefix. If you don't specify a value, no prefix filter is applied. </p>",
460564 "refs": {
461565 "DescribeDestinationsRequest$nextToken": null,
462566 "DescribeDestinationsResponse$nextToken": null,
567 "DescribeExportTasksRequest$nextToken": "<p> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class=\"code\">DescribeExportTasks</code> request. </p>",
568 "DescribeExportTasksResponse$nextToken": null,
463569 "DescribeLogGroupsRequest$nextToken": "<p> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class=\"code\">DescribeLogGroups</code> request. </p>",
464570 "DescribeLogGroupsResponse$nextToken": null,
465571 "DescribeLogStreamsRequest$nextToken": "<p> A string token used for pagination that points to the next page of results. It must be a value obtained from the response of the previous <code class=\"code\">DescribeLogStreams</code> request. </p>",
557663 "RoleArn": {
558664 "base": null,
559665 "refs": {
560 "Destination$roleArn": null,
666 "Destination$roleArn": "<p>A role for impersonation for delivering log events to the target.</p>",
561667 "PutDestinationRequest$roleArn": "<p>The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.</p>",
562668 "PutSubscriptionFilterRequest$roleArn": "<p>The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination (used via an ARN of <code>Destination</code>) for cross-account delivery.</p>",
563669 "SubscriptionFilter$roleArn": null
618724 "TargetArn": {
619725 "base": null,
620726 "refs": {
621 "Destination$targetArn": null,
727 "Destination$targetArn": "<p>ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).</p>",
622728 "PutDestinationRequest$targetArn": "<p>The ARN of an Amazon Kinesis stream to deliver matching log events to.</p>"
623729 }
624730 },
641747 "Timestamp": {
642748 "base": "<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.</p>",
643749 "refs": {
644 "Destination$creationTime": null,
750 "CreateExportTaskRequest$from": "<p>A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time will not be exported.</p>",
751 "CreateExportTaskRequest$to": "<p>A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time will not be exported.</p>",
752 "Destination$creationTime": "<p>A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC specifying when this destination was created.</p>",
753 "ExportTask$from": "<p>A unix timestamp indicating the start time of the range for the request. Events with a timestamp prior to this time were not exported.</p>",
754 "ExportTask$to": "<p>A unix timestamp indicating the end time of the range for the request. Events with a timestamp later than this time were not exported.</p>",
755 "ExportTaskExecutionInfo$creationTime": "<p>A point in time when the export task got created.</p>",
756 "ExportTaskExecutionInfo$completionTime": "<p>A point in time when the export task got completed.</p>",
645757 "FilterLogEventsRequest$startTime": "<p>A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.</p>",
646758 "FilterLogEventsRequest$endTime": "<p>A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.</p>",
647759 "FilteredLogEvent$timestamp": null,
+1
-5
apis/machinelearning/2014-12-12/api-2.json less more
17321732 }
17331733 },
17341734 "VariableName":{"type":"string"},
1735 "VariableValue":{
1736 "type":"string",
1737 "max":1024,
1738 "pattern":"[a-zA-Z0-9_]*"
1739 },
1735 "VariableValue":{"type":"string"},
17401736 "Verbose":{"type":"boolean"},
17411737 "VipURL":{
17421738 "type":"string",
+14
-14
apis/machinelearning/2014-12-12/docs-2.json less more
77 "CreateEvaluation": "<p>Creates a new <code>Evaluation</code> of an <code>MLModel</code>. An <code>MLModel</code> is evaluated on a set of observations associated to a <code>DataSource</code>. Like a <code>DataSource</code> for an <code>MLModel</code>, the <code>DataSource</code> for an <code>Evaluation</code> contains values for the Target Variable. The <code>Evaluation</code> compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the <code>MLModel</code> functions on the test data. Evaluation generates a relevant performance metric such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding <code>MLModelType</code>: <code>BINARY</code>, <code>REGRESSION</code> or <code>MULTICLASS</code>. </p> <p><code>CreateEvaluation</code> is an asynchronous operation. In response to <code>CreateEvaluation</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to <code>PENDING</code>. After the <code>Evaluation</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </p> <p>You can use the <a>GetEvaluation</a> operation to check progress of the evaluation during the creation operation.</p>",
88 "CreateMLModel": "<p>Creates a new <code>MLModel</code> using the data files and the recipe as information sources. </p> <p>An <code>MLModel</code> is nearly immutable. Users can only update the <code>MLModelName</code> and the <code>ScoreThreshold</code> in an <code>MLModel</code> without creating a new <code>MLModel</code>. </p> <p><code>CreateMLModel</code> is an asynchronous operation. In response to <code>CreateMLModel</code>, Amazon Machine Learning (Amazon ML) immediately returns and sets the <code>MLModel</code> status to <code>PENDING</code>. After the <code>MLModel</code> is created and ready for use, Amazon ML sets the status to <code>COMPLETED</code>. </p> <p>You can use the <a>GetMLModel</a> operation to check progress of the <code>MLModel</code> during the creation operation.</p> <p> <a>CreateMLModel</a> requires a <code>DataSource</code> with computed statistics, which can be created by setting <code>ComputeStatistics</code> to <code>true</code> in <a>CreateDataSourceFromRDS</a>, <a>CreateDataSourceFromS3</a>, or <a>CreateDataSourceFromRedshift</a> operations. </p>",
99 "CreateRealtimeEndpoint": "<p>Creates a real-time endpoint for the <code>MLModel</code>. The endpoint contains the URI of the <code>MLModel</code>; that is, the location to send real-time prediction requests for the specified <code>MLModel</code>.</p>",
10 "DeleteBatchPrediction": "<p>Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable.</p> <p>After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED.</p> <caution><title>Caution</title> <p>The result of the <code>DeleteBatchPrediction</code> operation is irreversible.</p></caution>",
11 "DeleteDataSource": "<p>Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable.</p> <p>After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED.</p> <caution><title>Caution</title> <p>The results of the <code>DeleteDataSource</code> operation are irreversible.</p></caution>",
12 "DeleteEvaluation": "<p>Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable.</p> <p>After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>.</p> <caution><title>Caution</title> <p>The results of the <code>DeleteEvaluation</code> operation are irreversible.</p></caution>",
13 "DeleteMLModel": "<p>Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable.</p> <p>After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED.</p> <caution><title>Caution</title> <p>The result of the <code>DeleteMLModel</code> operation is irreversible.</p></caution>",
10 "DeleteBatchPrediction": "<p>Assigns the DELETED status to a <code>BatchPrediction</code>, rendering it unusable.</p> <p>After using the <code>DeleteBatchPrediction</code> operation, you can use the <a>GetBatchPrediction</a> operation to verify that the status of the <code>BatchPrediction</code> changed to DELETED.</p> <p><b>Caution:</b> The result of the <code>DeleteBatchPrediction</code> operation is irreversible.</p>",
11 "DeleteDataSource": "<p>Assigns the DELETED status to a <code>DataSource</code>, rendering it unusable.</p> <p>After using the <code>DeleteDataSource</code> operation, you can use the <a>GetDataSource</a> operation to verify that the status of the <code>DataSource</code> changed to DELETED.</p> <p><b>Caution:</b> The results of the <code>DeleteDataSource</code> operation are irreversible.</p>",
12 "DeleteEvaluation": "<p>Assigns the <code>DELETED</code> status to an <code>Evaluation</code>, rendering it unusable.</p> <p>After invoking the <code>DeleteEvaluation</code> operation, you can use the <a>GetEvaluation</a> operation to verify that the status of the <code>Evaluation</code> changed to <code>DELETED</code>.</p> <p><b>Caution:</b> The results of the <code>DeleteEvaluation</code> operation are irreversible.</p>",
13 "DeleteMLModel": "<p>Assigns the DELETED status to an <code>MLModel</code>, rendering it unusable.</p> <p>After using the <code>DeleteMLModel</code> operation, you can use the <a>GetMLModel</a> operation to verify that the status of the <code>MLModel</code> changed to DELETED.</p> <p><b>Caution:</b> The result of the <code>DeleteMLModel</code> operation is irreversible.</p>",
1414 "DeleteRealtimeEndpoint": "<p>Deletes a real time endpoint of an <code>MLModel</code>.</p>",
1515 "DescribeBatchPredictions": "<p>Returns a list of <code>BatchPrediction</code> operations that match the search criteria in the request.</p>",
1616 "DescribeDataSources": "<p>Returns a list of <code>DataSource</code> that match the search criteria in the request.</p>",
2020 "GetDataSource": "<p>Returns a <code>DataSource</code> that includes metadata and data file information, as well as the current status of the <code>DataSource</code>.</p> <p><code>GetDataSource</code> provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.</p>",
2121 "GetEvaluation": "<p>Returns an <code>Evaluation</code> that includes metadata as well as the current status of the <code>Evaluation</code>.</p>",
2222 "GetMLModel": "<p>Returns an <code>MLModel</code> that includes detailed metadata, and data source information as well as the current status of the <code>MLModel</code>.</p> <p><code>GetMLModel</code> provides results in normal or verbose format. </p>",
23 "Predict": "<p>Generates a prediction for the observation using the specified <code>MLModel</code>.</p> <note><title>Note</title> <p>Not all response parameters will be populated because this is dependent on the type of requested model.</p></note>",
23 "Predict": "<p>Generates a prediction for the observation using the specified <code>ML Model</code>.</p> <note><title>Note</title> <p>Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.</p></note>",
2424 "UpdateBatchPrediction": "<p>Updates the <code>BatchPredictionName</code> of a <code>BatchPrediction</code>.</p> <p>You can use the <a>GetBatchPrediction</a> operation to view the contents of the updated data element.</p>",
2525 "UpdateDataSource": "<p>Updates the <code>DataSourceName</code> of a <code>DataSource</code>.</p> <p>You can use the <a>GetDataSource</a> operation to view the contents of the updated data element.</p>",
2626 "UpdateEvaluation": "<p>Updates the <code>EvaluationName</code> of an <code>Evaluation</code>.</p> <p>You can use the <a>GetEvaluation</a> operation to view the contents of the updated data element.</p>",
183183 "refs": {
184184 "DataSource$DataRearrangement": "<p>A JSON string that represents the splitting requirement of a <code>Datasource</code>. </p>",
185185 "GetDataSourceOutput$DataRearrangement": "<p>A JSON string that captures the splitting rearrangement requirement of the <code>DataSource</code>.</p>",
186 "RDSDataSpec$DataRearrangement": "<p>DataRearrangement - A JSON string that represents the splitting requirement of a <code>DataSource</code>. </p> <br> <p> Sample - <code> \"{\\\"randomSeed\\\":\\\"some-random-seed\\\", \\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p>",
186 "RDSDataSpec$DataRearrangement": "<p>DataRearrangement - A JSON string that represents the splitting requirement of a <code>DataSource</code>. </p> <br> <p> Sample - <code> \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p>",
187187 "RedshiftDataSpec$DataRearrangement": "<p>Describes the splitting specifications for a <code>DataSource</code>.</p>",
188188 "S3DataSpec$DataRearrangement": "<p> Describes the splitting requirement of a <code>Datasource</code>.</p>"
189189 }
190190 },
191191 "DataSchema": {
192 "base": "<p>The schema of a <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>. The DataSource schema is expressed in JSON format.</p> { \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }",
192 "base": "<p>The schema of a <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>. The DataSource schema is expressed in JSON format.</p> <p><code>DataSchema</code> is not required if you specify a <code>DataSchemaUri</code></p> <p>{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] } </p>",
193193 "refs": {
194194 "GetDataSourceOutput$DataSourceSchema": "<p>The schema used by all of the data files of this <code>DataSource</code>.</p> <note><title>Note</title> <p>This parameter is provided as part of the verbose format.</p></note>",
195195 "GetMLModelOutput$Schema": "<p>The schema used by all of the data files referenced by the <code>DataSource</code>.</p> <note><title>Note</title> <p>This parameter is provided as part of the verbose format.</p></note>",
196 "RDSDataSpec$DataSchema": "<p>A JSON string that represents the schema. This is not required if <code>DataSchemaUri</code> is specified. </p>",
197 "RedshiftDataSpec$DataSchema": "<p>Describes the schema for an Amazon Redshift <code>DataSource</code>.</p>",
198 "S3DataSpec$DataSchema": "<p> Describes the schema for an Amazon S3 <code>DataSource</code>.</p>"
196 "RDSDataSpec$DataSchema": "<p>A JSON string that represents the schema for an Amazon RDS <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</p> <p>A <code>DataSchema</code> is not required if you specify a <code>DataSchemaUri</code></p> <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</p> <p>{ \"version\": \"1.0\",</p> <p> \"recordAnnotationFieldName\": \"F1\",</p> <p> \"recordWeightFieldName\": \"F2\",</p> <p> \"targetFieldName\": \"F3\",</p> <p> \"dataFormat\": \"CSV\",</p> <p> \"dataFileContainsHeader\": true,</p> <p> \"attributes\": [</p> <p> { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],</p> <p> \"excludedVariableNames\": [ \"F6\" ] } </p> <?oxy_insert_end>",
197 "RedshiftDataSpec$DataSchema": "<p>A JSON string that represents the schema for an Amazon Redshift <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</p> <p>A <code>DataSchema</code> is not required if you specify a <code>DataSchemaUri</code>.</p> <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</p> <p>{ \"version\": \"1.0\",</p> <p> \"recordAnnotationFieldName\": \"F1\",</p> <p> \"recordWeightFieldName\": \"F2\",</p> <p> \"targetFieldName\": \"F3\",</p> <p> \"dataFormat\": \"CSV\",</p> <p> \"dataFileContainsHeader\": true,</p> <p> \"attributes\": [</p> <p> { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],</p> <p> \"excludedVariableNames\": [ \"F6\" ] } </p>",
198 "S3DataSpec$DataSchema": "<p> A JSON string that represents the schema for an Amazon S3 <code>DataSource</code>. The <code>DataSchema</code> defines the structure of the observation data in the data file(s) referenced in the <code>DataSource</code>.</p> <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code> and <code>excludedVariableNames</code> have an array of key-value pairs for their value. Use the following format to define your <code>DataSchema</code>.</p> <p>{ \"version\": \"1.0\",</p> <p> \"recordAnnotationFieldName\": \"F1\",</p> <p> \"recordWeightFieldName\": \"F2\",</p> <p> \"targetFieldName\": \"F3\",</p> <p> \"dataFormat\": \"CSV\",</p> <p> \"dataFileContainsHeader\": true,</p> <p> \"attributes\": [</p> <p> { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],</p> <p> \"excludedVariableNames\": [ \"F6\" ] } </p> <?oxy_insert_end>"
199199 }
200200 },
201201 "DataSource": {
721721 "RDSDataSpec": {
722722 "base": "<p>The data specification of an Amazon Relational Database Service (Amazon RDS) <code>DataSource</code>.</p>",
723723 "refs": {
724 "CreateDataSourceFromRDSInput$RDSData": "<p>The data specification of an Amazon RDS <code>DataSource</code>:</p> <ul> <li><p>DatabaseInformation - <ul> <li> <code>DatabaseName </code> - Name of the Amazon RDS database.</li> <li> <code> InstanceIdentifier </code> - Unique identifier for the Amazon RDS database instance.</li> </ul> </p></li> <li><p>DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.</p></li> <li><p>ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see <a href=\"http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html\">Role templates</a> for data pipelines.</p></li> <li><p>ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see <a href=\"http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html\">Role templates</a> for data pipelines.</p></li> <li><p>SecurityInfo - Security information to use to access an Amazon RDS instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [<code>SubnetId</code>, <code>SecurityGroupIds</code>] pair for a VPC-based Amazon RDS instance.</p></li> <li><p>SelectSqlQuery - Query that is used to retrieve the observation data for the <code>Datasource</code>.</p></li> <li><p>S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p></li> <li><p>DataSchemaUri - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"randomSeed\\\":\\\"some-random-seed\\\", \\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
724 "CreateDataSourceFromRDSInput$RDSData": "<p>The data specification of an Amazon RDS <code>DataSource</code>:</p> <ul> <li><p>DatabaseInformation - <ul> <li> <code>DatabaseName </code> - Name of the Amazon RDS database.</li> <li> <code> InstanceIdentifier </code> - Unique identifier for the Amazon RDS database instance.</li> </ul> </p></li> <li><p>DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.</p></li> <li><p>ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see <a href=\"http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html\">Role templates</a> for data pipelines.</p></li> <li><p>ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon Simple Storage Service (S3). For more information, see <a href=\"http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html\">Role templates</a> for data pipelines.</p></li> <li><p>SecurityInfo - Security information to use to access an Amazon RDS instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [<code>SubnetId</code>, <code>SecurityGroupIds</code>] pair for a VPC-based Amazon RDS instance.</p></li> <li><p>SelectSqlQuery - Query that is used to retrieve the observation data for the <code>Datasource</code>.</p></li> <li><p>S3StagingLocation - Amazon S3 location for staging RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p></li> <li><p>DataSchemaUri - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
725725 }
726726 },
727727 "RDSDatabase": {
813813 "RedshiftDataSpec": {
814814 "base": "<p>Describes the data specification of an Amazon Redshift <code>DataSource</code>.</p>",
815815 "refs": {
816 "CreateDataSourceFromRedshiftInput$DataSpec": "<p>The data specification of an Amazon Redshift <code>DataSource</code>:</p> <ul> <li><p>DatabaseInformation - <ul> <li> <code>DatabaseName </code> - Name of the Amazon Redshift database. </li> <li> <code> ClusterIdentifier </code> - Unique ID for the Amazon Redshift cluster.</li> </ul></p></li> <li><p>DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.</p></li> <li><p>SelectSqlQuery - Query that is used to retrieve the observation data for the <code>Datasource</code>.</p></li> <li><p>S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (Amazon RDS) using <code>SelectSqlQuery</code> is stored in this location.</p></li> <li><p>DataSchemaUri - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"randomSeed\\\":\\\"some-random-seed\\\", \\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
816 "CreateDataSourceFromRedshiftInput$DataSpec": "<p>The data specification of an Amazon Redshift <code>DataSource</code>:</p> <ul> <li><p>DatabaseInformation - <ul> <li> <code>DatabaseName </code> - Name of the Amazon Redshift database. </li> <li> <code> ClusterIdentifier </code> - Unique ID for the Amazon Redshift cluster.</li> </ul></p></li> <li><p>DatabaseCredentials - AWS Identity abd Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.</p></li> <li><p>SelectSqlQuery - Query that is used to retrieve the observation data for the <code>Datasource</code>.</p></li> <li><p>S3StagingLocation - Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Relational Database Service (Amazon RDS) using <code>SelectSqlQuery</code> is stored in this location.</p></li> <li><p>DataSchemaUri - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
817817 }
818818 },
819819 "RedshiftDatabase": {
849849 }
850850 },
851851 "RedshiftMetadata": {
852 "base": "<p>Describes the <Code>DataSource</Code> details specific to Amazon Redshift.</p>",
852 "base": "<p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>",
853853 "refs": {
854854 "DataSource$RedshiftMetadata": null,
855855 "GetDataSourceOutput$RedshiftMetadata": null
879879 "S3DataSpec": {
880880 "base": "<p> Describes the data specification of a <code>DataSource</code>.</p>",
881881 "refs": {
882 "CreateDataSourceFromS3Input$DataSpec": "<p>The data specification of a <code>DataSource</code>:</p> <ul> <li><p>DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.</p></li> <li><p>DataSchemaLocationS3 - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"randomSeed\\\":\\\"some-random-seed\\\", \\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
882 "CreateDataSourceFromS3Input$DataSpec": "<p>The data specification of a <code>DataSource</code>:</p> <ul> <li><p>DataLocationS3 - Amazon Simple Storage Service (Amazon S3) location of the observation data.</p></li> <li><p>DataSchemaLocationS3 - Amazon S3 location of the <code>DataSchema</code>.</p></li> <li><p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p></li> <li> <p>DataRearrangement - A JSON string representing the splitting requirement of a <code>Datasource</code>. </p> <br> <p> Sample - <code> \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"</code> </p> </li> </ul>"
883883 }
884884 },
885885 "S3Url": {
+26
-3
apis/route53/2013-04-01/api-2.json less more
961961 "type":"list",
962962 "member":{"shape":"IPAddressCidr"}
963963 },
964 "ChildHealthCheckList":{
965 "type":"list",
966 "member":{
967 "shape":"HealthCheckId",
968 "locationName":"ChildHealthCheck"
969 },
970 "max":256
971 },
964972 "ConflictingDomainExists":{
965973 "type":"structure",
966974 "members":{
14681476 "FullyQualifiedDomainName":{"shape":"FullyQualifiedDomainName"},
14691477 "SearchString":{"shape":"SearchString"},
14701478 "RequestInterval":{"shape":"RequestInterval"},
1471 "FailureThreshold":{"shape":"FailureThreshold"}
1479 "FailureThreshold":{"shape":"FailureThreshold"},
1480 "MeasureLatency":{"shape":"MeasureLatency"},
1481 "Inverted":{"shape":"Inverted"},
1482 "HealthThreshold":{"shape":"HealthThreshold"},
1483 "ChildHealthChecks":{"shape":"ChildHealthCheckList"}
14721484 }
14731485 },
14741486 "HealthCheckCount":{"type":"long"},
15101522 "HTTPS",
15111523 "HTTP_STR_MATCH",
15121524 "HTTPS_STR_MATCH",
1513 "TCP"
1525 "TCP",
1526 "CALCULATED"
15141527 ]
15151528 },
15161529 "HealthCheckVersion":{
15311544 "shape":"HealthCheck",
15321545 "locationName":"HealthCheck"
15331546 }
1547 },
1548 "HealthThreshold":{
1549 "type":"integer",
1550 "min":0,
1551 "max":256
15341552 },
15351553 "HostedZone":{
15361554 "type":"structure",
16381656 "error":{"httpStatusCode":400},
16391657 "exception":true
16401658 },
1659 "Inverted":{"type":"boolean"},
16411660 "IsPrivateZone":{"type":"boolean"},
16421661 "LastVPCAssociation":{
16431662 "type":"structure",
19251944 "ResourceTagSets":{"shape":"ResourceTagSetList"}
19261945 }
19271946 },
1947 "MeasureLatency":{"type":"boolean"},
19281948 "NoSuchChange":{
19291949 "type":"structure",
19301950 "members":{
22362256 "ResourcePath":{"shape":"ResourcePath"},
22372257 "FullyQualifiedDomainName":{"shape":"FullyQualifiedDomainName"},
22382258 "SearchString":{"shape":"SearchString"},
2239 "FailureThreshold":{"shape":"FailureThreshold"}
2259 "FailureThreshold":{"shape":"FailureThreshold"},
2260 "Inverted":{"shape":"Inverted"},
2261 "HealthThreshold":{"shape":"HealthThreshold"},
2262 "ChildHealthChecks":{"shape":"ChildHealthCheckList"}
22402263 }
22412264 },
22422265 "UpdateHealthCheckResponse":{
+28
-0
apis/route53/2013-04-01/docs-2.json less more
128128 "GetCheckerIpRangesResponse$CheckerIpRanges": "<p>A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.</p>"
129129 }
130130 },
131 "ChildHealthCheckList": {
132 "base": null,
133 "refs": {
134 "HealthCheckConfig$ChildHealthChecks": "<p>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks.</p>",
135 "UpdateHealthCheckRequest$ChildHealthChecks": "<p>For a specified parent health check, a list of <code>HealthCheckId</code> values for the associated child health checks.</p> <p>Specify this value only if you want to change it.</p>"
136 }
137 },
131138 "ConflictingDomainExists": {
132139 "base": null,
133140 "refs": {
524531 "HealthCheckId": {
525532 "base": null,
526533 "refs": {
534 "ChildHealthCheckList$member": null,
527535 "DeleteHealthCheckRequest$HealthCheckId": "<p>The ID of the health check to delete.</p>",
528536 "GetHealthCheckLastFailureReasonRequest$HealthCheckId": "<p>The ID of the health check for which you want to retrieve the reason for the most recent failure.</p>",
529537 "GetHealthCheckRequest$HealthCheckId": "<p>The ID of the health check to retrieve.</p>",
582590 "ListHealthChecksResponse$HealthChecks": "<p>A complex type that contains information about the health checks associated with the current AWS account.</p>"
583591 }
584592 },
593 "HealthThreshold": {
594 "base": null,
595 "refs": {
596 "HealthCheckConfig$HealthThreshold": "<p>The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.</p>",
597 "UpdateHealthCheckRequest$HealthThreshold": "<p>The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.</p> <p>Specify this value only if you want to change it.</p>"
598 }
599 },
585600 "HostedZone": {
586601 "base": "<p>A complex type that contain information about the specified hosted zone.</p>",
587602 "refs": {
676691 "refs": {
677692 }
678693 },
694 "Inverted": {
695 "base": null,
696 "refs": {
697 "HealthCheckConfig$Inverted": "<p>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Route 53 considers the health check to be unhealthy.</p>",
698 "UpdateHealthCheckRequest$Inverted": "<p>A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but <code>Inverted</code> is <code>True</code>, then Route 53 considers the health check to be unhealthy.</p> <p>Specify this value only if you want to change it.</p>"
699 }
700 },
679701 "IsPrivateZone": {
680702 "base": null,
681703 "refs": {
770792 "ListTagsForResourcesResponse": {
771793 "base": "<p>A complex type containing tags for the specified resources.</p>",
772794 "refs": {
795 }
796 },
797 "MeasureLatency": {
798 "base": null,
799 "refs": {
800 "HealthCheckConfig$MeasureLatency": "<p>A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.</p>"
773801 }
774802 },
775803 "NoSuchChange": {
+124
-5
apis/s3/2006-03-01/api-2.json less more
193193 },
194194 "input":{"shape":"GetBucketLifecycleRequest"},
195195 "output":{"shape":"GetBucketLifecycleOutput"},
196 "deprecated":true,
196197 "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html"
198 },
199 "GetBucketLifecycleConfiguration":{
200 "name":"GetBucketLifecycleConfiguration",
201 "http":{
202 "method":"GET",
203 "requestUri":"/{Bucket}?lifecycle"
204 },
205 "input":{"shape":"GetBucketLifecycleConfigurationRequest"},
206 "output":{"shape":"GetBucketLifecycleConfigurationOutput"}
197207 },
198208 "GetBucketLocation":{
199209 "name":"GetBucketLocation",
450460 "requestUri":"/{Bucket}?lifecycle"
451461 },
452462 "input":{"shape":"PutBucketLifecycleRequest"},
463 "deprecated":true,
453464 "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html"
465 },
466 "PutBucketLifecycleConfiguration":{
467 "name":"PutBucketLifecycleConfiguration",
468 "http":{
469 "method":"PUT",
470 "requestUri":"/{Bucket}?lifecycle"
471 },
472 "input":{"shape":"PutBucketLifecycleConfigurationRequest"}
454473 },
455474 "PutBucketLogging":{
456475 "name":"PutBucketLogging",
688707 "public-read-write",
689708 "authenticated-read"
690709 ]
710 },
711 "BucketLifecycleConfiguration":{
712 "type":"structure",
713 "required":["Rules"],
714 "members":{
715 "Rules":{
716 "shape":"LifecycleRules",
717 "locationName":"Rule"
718 }
719 }
691720 },
692721 "BucketLocationConstraint":{
693722 "type":"string",
735764 },
736765 "CORSConfiguration":{
737766 "type":"structure",
767 "required":["CORSRules"],
738768 "members":{
739769 "CORSRules":{
740770 "shape":"CORSRules",
744774 },
745775 "CORSRule":{
746776 "type":"structure",
777 "required":[
778 "AllowedMethods",
779 "AllowedOrigins"
780 ],
747781 "members":{
748782 "AllowedHeaders":{
749783 "shape":"AllowedHeaders",
15891623 "type":"structure",
15901624 "required":["Bucket"],
15911625 "members":{
1592 "Bucket":{"shape":"BucketName"}
1626 "Bucket":{"shape":"BucketName"},
1627 "StorageClass":{"shape":"StorageClass"}
15931628 }
15941629 },
15951630 "DisplayName":{"type":"string"},
17151750 }
17161751 }
17171752 },
1753 "GetBucketLifecycleConfigurationOutput":{
1754 "type":"structure",
1755 "members":{
1756 "Rules":{
1757 "shape":"LifecycleRules",
1758 "locationName":"Rule"
1759 }
1760 }
1761 },
1762 "GetBucketLifecycleConfigurationRequest":{
1763 "type":"structure",
1764 "required":["Bucket"],
1765 "members":{
1766 "Bucket":{
1767 "shape":"BucketName",
1768 "location":"uri",
1769 "locationName":"Bucket"
1770 }
1771 }
1772 },
17181773 "GetBucketLifecycleOutput":{
17191774 "type":"structure",
17201775 "members":{
25212576 "Date":{"shape":"Date"},
25222577 "Days":{"shape":"Days"}
25232578 }
2579 },
2580 "LifecycleRule":{
2581 "type":"structure",
2582 "required":[
2583 "Prefix",
2584 "Status"
2585 ],
2586 "members":{
2587 "Expiration":{"shape":"LifecycleExpiration"},
2588 "ID":{"shape":"ID"},
2589 "Prefix":{"shape":"Prefix"},
2590 "Status":{"shape":"ExpirationStatus"},
2591 "Transitions":{
2592 "shape":"TransitionList",
2593 "locationName":"Transition"
2594 },
2595 "NoncurrentVersionTransitions":{
2596 "shape":"NoncurrentVersionTransitionList",
2597 "locationName":"NoncurrentVersionTransition"
2598 },
2599 "NoncurrentVersionExpiration":{"shape":"NoncurrentVersionExpiration"}
2600 }
2601 },
2602 "LifecycleRules":{
2603 "type":"list",
2604 "member":{"shape":"LifecycleRule"},
2605 "flattened":true
25242606 },
25252607 "ListBucketsOutput":{
25262608 "type":"structure",
28682950 "StorageClass":{"shape":"TransitionStorageClass"}
28692951 }
28702952 },
2953 "NoncurrentVersionTransitionList":{
2954 "type":"list",
2955 "member":{"shape":"NoncurrentVersionTransition"},
2956 "flattened":true
2957 },
28712958 "NotificationConfiguration":{
28722959 "type":"structure",
28732960 "members":{
29443031 "member":{"shape":"ObjectIdentifier"},
29453032 "flattened":true
29463033 },
2947 "ObjectKey":{"type":"string"},
3034 "ObjectKey":{
3035 "type":"string",
3036 "min":1
3037 },
29483038 "ObjectList":{
29493039 "type":"list",
29503040 "member":{"shape":"Object"},
30903180 },
30913181 "PutBucketCorsRequest":{
30923182 "type":"structure",
3093 "required":["Bucket"],
3183 "required":[
3184 "Bucket",
3185 "CORSConfiguration"
3186 ],
30943187 "members":{
30953188 "Bucket":{
30963189 "shape":"BucketName",
31093202 }
31103203 },
31113204 "payload":"CORSConfiguration"
3205 },
3206 "PutBucketLifecycleConfigurationRequest":{
3207 "type":"structure",
3208 "required":["Bucket"],
3209 "members":{
3210 "Bucket":{
3211 "shape":"BucketName",
3212 "location":"uri",
3213 "locationName":"Bucket"
3214 },
3215 "LifecycleConfiguration":{
3216 "shape":"BucketLifecycleConfiguration",
3217 "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"},
3218 "locationName":"LifecycleConfiguration"
3219 }
3220 },
3221 "payload":"LifecycleConfiguration"
31123222 },
31133223 "PutBucketLifecycleRequest":{
31143224 "type":"structure",
38603970 "type":"string",
38613971 "enum":[
38623972 "STANDARD",
3863 "REDUCED_REDUNDANCY"
3973 "REDUCED_REDUNDANCY",
3974 "STANDARD_IA"
38643975 ]
38653976 },
38663977 "Suffix":{"type":"string"},
39534064 "StorageClass":{"shape":"TransitionStorageClass"}
39544065 }
39554066 },
4067 "TransitionList":{
4068 "type":"list",
4069 "member":{"shape":"Transition"},
4070 "flattened":true
4071 },
39564072 "TransitionStorageClass":{
39574073 "type":"string",
3958 "enum":["GLACIER"]
4074 "enum":[
4075 "GLACIER",
4076 "STANDARD_IA"
4077 ]
39594078 },
39604079 "Type":{
39614080 "type":"string",
+63
-5
apis/s3/2006-03-01/docs-2.json less more
1616 "DeleteObjects": "This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.",
1717 "GetBucketAcl": "Gets the access control policy for the bucket.",
1818 "GetBucketCors": "Returns the cors configuration for the bucket.",
19 "GetBucketLifecycle": "Returns the lifecycle configuration information set on the bucket.",
19 "GetBucketLifecycle": "Deprecated, see the GetBucketLifecycleConfiguration operation.",
20 "GetBucketLifecycleConfiguration": "Returns the lifecycle configuration information set on the bucket.",
2021 "GetBucketLocation": "Returns the region the bucket resides in.",
2122 "GetBucketLogging": "Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.",
2223 "GetBucketNotification": "Deprecated, see the GetBucketNotificationConfiguration operation.",
3940 "ListParts": "Lists the parts that have been uploaded for a specific multipart upload.",
4041 "PutBucketAcl": "Sets the permissions on a bucket using access control lists (ACL).",
4142 "PutBucketCors": "Sets the cors configuration for a bucket.",
42 "PutBucketLifecycle": "Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.",
43 "PutBucketLifecycle": "Deprecated, see the PutBucketLifecycleConfiguration operation.",
44 "PutBucketLifecycleConfiguration": "Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.",
4345 "PutBucketLogging": "Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.",
4446 "PutBucketNotification": "Deprecated, see the PutBucketNotificationConfiguraiton operation.",
4547 "PutBucketNotificationConfiguration": "Enables notifications of specified events for a bucket.",
142144 "refs": {
143145 "CreateBucketRequest$ACL": "The canned ACL to apply to the bucket.",
144146 "PutBucketAclRequest$ACL": "The canned ACL to apply to the bucket."
147 }
148 },
149 "BucketLifecycleConfiguration": {
150 "base": null,
151 "refs": {
152 "PutBucketLifecycleConfigurationRequest$LifecycleConfiguration": null
145153 }
146154 },
147155 "BucketLocationConstraint": {
186194 "Destination$Bucket": "Amazon resource name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.",
187195 "GetBucketAclRequest$Bucket": null,
188196 "GetBucketCorsRequest$Bucket": null,
197 "GetBucketLifecycleConfigurationRequest$Bucket": null,
189198 "GetBucketLifecycleRequest$Bucket": null,
190199 "GetBucketLocationRequest$Bucket": null,
191200 "GetBucketLoggingRequest$Bucket": null,
211220 "ListPartsRequest$Bucket": null,
212221 "PutBucketAclRequest$Bucket": null,
213222 "PutBucketCorsRequest$Bucket": null,
223 "PutBucketLifecycleConfigurationRequest$Bucket": null,
214224 "PutBucketLifecycleRequest$Bucket": null,
215225 "PutBucketLoggingRequest$Bucket": null,
216226 "PutBucketNotificationConfigurationRequest$Bucket": null,
766776 "ExpirationStatus": {
767777 "base": null,
768778 "refs": {
779 "LifecycleRule$Status": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.",
769780 "Rule$Status": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied."
770781 }
771782 },
831842 }
832843 },
833844 "GetBucketCorsRequest": {
845 "base": null,
846 "refs": {
847 }
848 },
849 "GetBucketLifecycleConfigurationOutput": {
850 "base": null,
851 "refs": {
852 }
853 },
854 "GetBucketLifecycleConfigurationRequest": {
834855 "base": null,
835856 "refs": {
836857 }
10721093 "refs": {
10731094 "Grantee$ID": "The canonical user ID of the grantee.",
10741095 "Initiator$ID": "If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.",
1096 "LifecycleRule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters.",
10751097 "Owner$ID": null,
10761098 "ReplicationRule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters.",
10771099 "Rule$ID": "Unique identifier for the rule. The value cannot be longer than 255 characters."
11961218 "LifecycleExpiration": {
11971219 "base": null,
11981220 "refs": {
1221 "LifecycleRule$Expiration": null,
11991222 "Rule$Expiration": null
1223 }
1224 },
1225 "LifecycleRule": {
1226 "base": null,
1227 "refs": {
1228 "LifecycleRules$member": null
1229 }
1230 },
1231 "LifecycleRules": {
1232 "base": null,
1233 "refs": {
1234 "BucketLifecycleConfiguration$Rules": null,
1235 "GetBucketLifecycleConfigurationOutput$Rules": null
12001236 }
12011237 },
12021238 "ListBucketsOutput": {
14291465 "NoncurrentVersionExpiration": {
14301466 "base": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.",
14311467 "refs": {
1468 "LifecycleRule$NoncurrentVersionExpiration": null,
14321469 "Rule$NoncurrentVersionExpiration": null
14331470 }
14341471 },
14351472 "NoncurrentVersionTransition": {
1436 "base": "Container for the transition rule that describes when noncurrent objects transition to the GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the GLACIER storage class at a specific period in the object's lifetime.",
1437 "refs": {
1473 "base": "Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA or GLACIER storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA or GLACIER storage class at a specific period in the object's lifetime.",
1474 "refs": {
1475 "NoncurrentVersionTransitionList$member": null,
14381476 "Rule$NoncurrentVersionTransition": null
1477 }
1478 },
1479 "NoncurrentVersionTransitionList": {
1480 "base": null,
1481 "refs": {
1482 "LifecycleRule$NoncurrentVersionTransitions": null
14391483 }
14401484 },
14411485 "NotificationConfiguration": {
16541698 "base": null,
16551699 "refs": {
16561700 "CommonPrefix$Prefix": null,
1701 "LifecycleRule$Prefix": "Prefix identifying one or more objects to which the rule applies.",
16571702 "ListMultipartUploadsOutput$Prefix": "When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.",
16581703 "ListMultipartUploadsRequest$Prefix": "Lists in-progress uploads only for those keys that begin with the specified prefix.",
16591704 "ListObjectVersionsOutput$Prefix": null,
16771722 }
16781723 },
16791724 "PutBucketCorsRequest": {
1725 "base": null,
1726 "refs": {
1727 }
1728 },
1729 "PutBucketLifecycleConfigurationRequest": {
16801730 "base": null,
16811731 "refs": {
16821732 }
20862136 "refs": {
20872137 "CopyObjectRequest$StorageClass": "The type of storage to use for the object. Defaults to 'STANDARD'.",
20882138 "CreateMultipartUploadRequest$StorageClass": "The type of storage to use for the object. Defaults to 'STANDARD'.",
2139 "Destination$StorageClass": "The class of storage used to store the object.",
20892140 "GetObjectOutput$StorageClass": null,
20902141 "HeadObjectOutput$StorageClass": null,
20912142 "ListPartsOutput$StorageClass": "The class of storage used to store the object.",
21702221 "Transition": {
21712222 "base": null,
21722223 "refs": {
2173 "Rule$Transition": null
2224 "Rule$Transition": null,
2225 "TransitionList$member": null
2226 }
2227 },
2228 "TransitionList": {
2229 "base": null,
2230 "refs": {
2231 "LifecycleRule$Transitions": null
21742232 }
21752233 },
21762234 "TransitionStorageClass": {
+71
-17
aws/corehandlers/param_validator.go less more
22 import (
33 "fmt"
44 "reflect"
5 "strconv"
56 "strings"
67
78 "github.com/aws/aws-sdk-go/aws/awserr"
6566 }
6667 fvalue := value.FieldByName(f.Name)
6768
68 notset := false
69 if f.Tag.Get("required") != "" {
70 switch fvalue.Kind() {
71 case reflect.Ptr, reflect.Slice, reflect.Map:
72 if fvalue.IsNil() {
73 notset = true
74 }
75 default:
76 if !fvalue.IsValid() {
77 notset = true
78 }
79 }
69 err := validateField(f, fvalue, validateFieldRequired, validateFieldMin)
70 if err != nil {
71 v.errors = append(v.errors, fmt.Sprintf("%s: %s", err.Error(), path+prefix+f.Name))
72 continue
8073 }
8174
82 if notset {
83 msg := "missing required parameter: " + path + prefix + f.Name
84 v.errors = append(v.errors, msg)
85 } else {
86 v.validateAny(fvalue, path+prefix+f.Name)
75 v.validateAny(fvalue, path+prefix+f.Name)
76 }
77 }
78
79 type validatorFunc func(f reflect.StructField, fvalue reflect.Value) error
80
81 func validateField(f reflect.StructField, fvalue reflect.Value, funcs ...validatorFunc) error {
82 for _, fn := range funcs {
83 if err := fn(f, fvalue); err != nil {
84 return err
8785 }
8886 }
87 return nil
8988 }
89
90 // Validates that a field has a valid value provided for required fields.
91 func validateFieldRequired(f reflect.StructField, fvalue reflect.Value) error {
92 if f.Tag.Get("required") == "" {
93 return nil
94 }
95
96 switch fvalue.Kind() {
97 case reflect.Ptr, reflect.Slice, reflect.Map:
98 if fvalue.IsNil() {
99 return fmt.Errorf("missing required parameter")
100 }
101 default:
102 if !fvalue.IsValid() {
103 return fmt.Errorf("missing required parameter")
104 }
105 }
106 return nil
107 }
108
109 // Validates that if a value is provided for a field, that value must be at
110 // least a minimum length.
111 func validateFieldMin(f reflect.StructField, fvalue reflect.Value) error {
112 minStr := f.Tag.Get("min")
113 if minStr == "" {
114 return nil
115 }
116 min, _ := strconv.ParseInt(minStr, 10, 64)
117
118 kind := fvalue.Kind()
119 if kind == reflect.Ptr {
120 if fvalue.IsNil() {
121 return nil
122 }
123 fvalue = fvalue.Elem()
124 }
125
126 switch fvalue.Kind() {
127 case reflect.String:
128 if int64(fvalue.Len()) < min {
129 return fmt.Errorf("field too short, minimum length %d", min)
130 }
131 case reflect.Slice, reflect.Map:
132 if fvalue.IsNil() {
133 return nil
134 }
135 if int64(fvalue.Len()) < min {
136 return fmt.Errorf("field too short, minimum length %d", min)
137 }
138
139 // TODO min can also apply to number minimum value.
140
141 }
142 return nil
143 }
+46
-3
aws/corehandlers/param_validator_test.go less more
1010 "github.com/aws/aws-sdk-go/aws/request"
1111 "github.com/aws/aws-sdk-go/aws/service"
1212 "github.com/aws/aws-sdk-go/aws/service/serviceinfo"
13 "github.com/stretchr/testify/require"
1314 )
1415
1516 var testSvc = func() *service.Service {
5657
5758 req := testSvc.NewRequest(&request.Operation{}, input, nil)
5859 corehandlers.ValidateParametersHandler.Fn(req)
59 assert.NoError(t, req.Error)
60 require.NoError(t, req.Error)
6061 }
6162
6263 func TestMissingRequiredParameters(t *testing.T) {
6465 req := testSvc.NewRequest(&request.Operation{}, input, nil)
6566 corehandlers.ValidateParametersHandler.Fn(req)
6667
67 assert.Error(t, req.Error)
68 require.Error(t, req.Error)
6869 assert.Equal(t, "InvalidParameter", req.Error.(awserr.Error).Code())
6970 assert.Equal(t, "3 validation errors:\n- missing required parameter: RequiredList\n- missing required parameter: RequiredMap\n- missing required parameter: RequiredBool", req.Error.(awserr.Error).Message())
7071 }
8384 req := testSvc.NewRequest(&request.Operation{}, input, nil)
8485 corehandlers.ValidateParametersHandler.Fn(req)
8586
86 assert.Error(t, req.Error)
87 require.Error(t, req.Error)
8788 assert.Equal(t, "InvalidParameter", req.Error.(awserr.Error).Code())
8889 assert.Equal(t, "3 validation errors:\n- missing required parameter: RequiredList[0].Name\n- missing required parameter: RequiredMap[\"key2\"].Name\n- missing required parameter: OptionalStruct.Name", req.Error.(awserr.Error).Message())
90 }
8991
92 type testInput struct {
93 StringField string `min:"5"`
94 PtrStrField *string `min:"2"`
95 ListField []string `min:"3"`
96 MapField map[string]string `min:"4"`
9097 }
98
99 var testsFieldMin = []struct {
100 err awserr.Error
101 in testInput
102 }{
103 {
104 err: awserr.New("InvalidParameter", "1 validation errors:\n- field too short, minimum length 5: StringField", nil),
105 in: testInput{StringField: "abcd"},
106 },
107 {
108 err: awserr.New("InvalidParameter", "2 validation errors:\n- field too short, minimum length 5: StringField\n- field too short, minimum length 3: ListField", nil),
109 in: testInput{StringField: "abcd", ListField: []string{"a", "b"}},
110 },
111 {
112 err: awserr.New("InvalidParameter", "3 validation errors:\n- field too short, minimum length 5: StringField\n- field too short, minimum length 3: ListField\n- field too short, minimum length 4: MapField", nil),
113 in: testInput{StringField: "abcd", ListField: []string{"a", "b"}, MapField: map[string]string{"a": "a", "b": "b"}},
114 },
115 {
116 err: awserr.New("InvalidParameter", "1 validation errors:\n- field too short, minimum length 2: PtrStrField", nil),
117 in: testInput{StringField: "abcde", PtrStrField: aws.String("v")},
118 },
119 {
120 err: nil,
121 in: testInput{StringField: "abcde", PtrStrField: aws.String("value"),
122 ListField: []string{"a", "b", "c"}, MapField: map[string]string{"a": "a", "b": "b", "c": "c", "d": "d"}},
123 },
124 }
125
126 func TestValidateFieldMinParameter(t *testing.T) {
127 for i, c := range testsFieldMin {
128 req := testSvc.NewRequest(&request.Operation{}, &c.in, nil)
129 corehandlers.ValidateParametersHandler.Fn(req)
130
131 require.Equal(t, c.err, req.Error, "%d case failed", i)
132 }
133 }
+4
-0
aws/credentials/stscreds/assume_role_provider.go less more
5353 // Expiry duration of the STS credentials. Defaults to 15 minutes if not set.
5454 Duration time.Duration
5555
56 // Optional ExternalID to pass along, defaults to nil if not set.
57 ExternalID *string
58
5659 // ExpiryWindow will allow the credentials to trigger refreshing prior to
5760 // the credentials actually expiring. This is beneficial so race conditions
5861 // with expiring credentials do not cause request to fail unexpectedly
103106 DurationSeconds: aws.Int64(int64(p.Duration / time.Second)),
104107 RoleArn: aws.String(p.RoleARN),
105108 RoleSessionName: aws.String(p.RoleSessionName),
109 ExternalId: p.ExternalID,
106110 })
107111
108112 if err != nil {
+1
-1
aws/version.go less more
44 const SDKName = "aws-sdk-go"
55
66 // SDKVersion is the version of this SDK
7 const SDKVersion = "0.9.5"
7 const SDKVersion = "0.9.9"
+0
-31
doc-src/plugin/templates/default/layout/html/footer.erb less more
0 <div id="footer">
1 Generated on <%= Time.now.strftime("%c") %> by
2 <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
3 <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
4 </div>
5
6 <!-- BEGIN-SECTION -->
7 <script type="text/javascript" src="https://media.amazonwebservices.com/amznUrchin.js"></script>
8 <!-- SiteCatalyst code version: H.25.2. Copyright 1996-2012 Adobe, Inc. All Rights Reserved.
9 More info available at http://www.omniture.com -->
10 <script language="JavaScript" type="text/javascript" src="https://media.amazonwebservices.com/js/sitecatalyst/s_code.min.js">
11 </script>
12 <script language="JavaScript" type="text/javascript">
13 <!--
14 s.prop66='AWS SDK for Go';
15 s.eVar66='D=c66';
16 s.prop65='API Reference';
17 s.eVar65='D=c65';
18 var s_code=s.t();if(s_code)document.write(s_code)
19 //-->
20 </script>
21 <script language="JavaScript" type="text/javascript">
22 <!--if(navigator.appVersion.indexOf('MSIE')>=0)document.write(unescape('%3C')+'\!-'+'-')
23 //-->
24 </script>
25 <noscript>
26 <img src="http://amazonwebservices.d2.sc.omtrdc.net/b/ss/awsamazondev/1/H.25.2--NS/0" height="1" width="1" border="0" alt="">
27 </noscript>
28 <!--/DO NOT REMOVE/-->
29 <!-- End SiteCatalyst code version: H.25.2. -->
30 <!-- END-SECTION -->
+2
-2
internal/features/smoke/autoscaling/autoscaling.feature less more
1010 | LaunchConfigurationName | |
1111 | ImageId | ami-12345678 |
1212 | InstanceType | m1.small |
13 Then I expect the response error code to be "ValidationError"
13 Then I expect the response error code to be "InvalidParameter"
1414 And I expect the response error message to include:
1515 """
16 Member must have length greater than or equal to 1
16 LaunchConfigurationName
1717 """
+2
-2
internal/features/smoke/dynamodbstreams/dynamodbstreams.feature less more
88 Scenario: Handling errors
99 When I attempt to call the "DescribeStream" API with:
1010 | StreamArn | fake-stream |
11 Then I expect the response error code to be "ValidationException"
11 Then I expect the response error code to be "InvalidParameter"
1212 And I expect the response error message to include:
1313 """
14 Invalid StreamArn
14 StreamArn
1515 """
+2
-2
internal/features/smoke/storagegateway/storagegateway.feature less more
88 Scenario: Handling errors
99 When I attempt to call the "ListVolumes" API with:
1010 | GatewayARN | fake_gateway |
11 Then I expect the response error code to be "ValidationException"
11 Then I expect the response error code to be "InvalidParameter"
1212 And I expect the response error message to include:
1313 """
14 Value 'fake_gateway' at 'gatewayARN' failed to satisfy constraint
14 GatewayARN
1515 """
+2
-2
internal/features/smoke/sts/sts.feature less more
99 When I attempt to call the "GetFederationToken" API with:
1010 | Name | temp |
1111 | Policy | |
12 Then I expect the response error code to be "ValidationError"
12 Then I expect the response error code to be "InvalidParameter"
1313 And I expect the response error message to include:
1414 """
15 Value '' at 'policy' failed to satisfy constraint
15 Policy
1616 """
+0
-5
internal/model/api/customization_passes.go less more
4343 }
4444 }
4545 }
46
47 // Rename "Rule" to "LifecycleRule"
48 if s, ok := a.Shapes["Rule"]; ok {
49 s.Rename("LifecycleRule")
50 }
5146 }
5247
5348 // cloudfrontCustomizations customized the API generation to replace values
+5
-0
internal/model/api/shape.go less more
5353 Location string
5454 LocationName string
5555 XMLNamespace XMLInfo
56 Min int // optional Minimum length (string, list) or value (number)
57 Max int // optional Minimum length (string, list) or value (number)
5658
5759 refs []*ShapeRef // References to this shape
5860 resolvePkg string // use this package in the goType() if present
194196 if ref.Shape.ValueRef.LocationName != "" {
195197 code += `locationNameValue:"` + ref.Shape.ValueRef.LocationName + `" `
196198 }
199 if ref.Shape.Min > 0 {
200 code += fmt.Sprintf(`min:"%d" `, ref.Shape.Min)
201 }
197202 code += `type:"` + ref.Shape.Type + `" `
198203
199204 // embed the timestamp type for easier lookups
+1
-1
internal/protocol/json/jsonutil/build.go less more
214214 value = value.Elem()
215215 }
216216 return value
217 }⏎
217 }
+1
-2
internal/protocol/json/jsonutil/unmarshal.go less more
66 "io"
77 "io/ioutil"
88 "reflect"
9 "strings"
109 "time"
1110 )
1211
9897
9998 for i := 0; i < t.NumField(); i++ {
10099 field := t.Field(i)
101 if c := field.Name[0:1]; strings.ToLower(c) == c {
100 if field.PkgPath != "" {
102101 continue // ignore unexported fields
103102 }
104103
+147
-147
service/autoscaling/api.go less more
16321632 ActivityId *string `type:"string" required:"true"`
16331633
16341634 // The name of the Auto Scaling group.
1635 AutoScalingGroupName *string `type:"string" required:"true"`
1635 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
16361636
16371637 // The reason the activity began.
1638 Cause *string `type:"string" required:"true"`
1638 Cause *string `min:"1" type:"string" required:"true"`
16391639
16401640 // A friendly, more verbose description of the activity.
16411641 Description *string `type:"string"`
16561656 StatusCode *string `type:"string" required:"true" enum:"ScalingActivityStatusCode"`
16571657
16581658 // A friendly, more verbose description of the activity status.
1659 StatusMessage *string `type:"string"`
1659 StatusMessage *string `min:"1" type:"string"`
16601660
16611661 metadataActivity `json:"-" xml:"-"`
16621662 }
16821682 type AdjustmentType struct {
16831683 // The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity,
16841684 // and PercentChangeInCapacity.
1685 AdjustmentType *string `type:"string"`
1685 AdjustmentType *string `min:"1" type:"string"`
16861686
16871687 metadataAdjustmentType `json:"-" xml:"-"`
16881688 }
17041704 // Describes an alarm.
17051705 type Alarm struct {
17061706 // The Amazon Resource Name (ARN) of the alarm.
1707 AlarmARN *string `type:"string"`
1707 AlarmARN *string `min:"1" type:"string"`
17081708
17091709 // The name of the alarm.
1710 AlarmName *string `type:"string"`
1710 AlarmName *string `min:"1" type:"string"`
17111711
17121712 metadataAlarm `json:"-" xml:"-"`
17131713 }
17281728
17291729 type AttachInstancesInput struct {
17301730 // The name of the group.
1731 AutoScalingGroupName *string `type:"string" required:"true"`
1731 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
17321732
17331733 // One or more EC2 instance IDs.
17341734 InstanceIds []*string `type:"list"`
17701770
17711771 type AttachLoadBalancersInput struct {
17721772 // The name of the group.
1773 AutoScalingGroupName *string `type:"string"`
1773 AutoScalingGroupName *string `min:"1" type:"string"`
17741774
17751775 // One or more load balancer names.
17761776 LoadBalancerNames []*string `type:"list"`
18131813 // Describes a block device mapping.
18141814 type BlockDeviceMapping struct {
18151815 // The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).
1816 DeviceName *string `type:"string" required:"true"`
1816 DeviceName *string `min:"1" type:"string" required:"true"`
18171817
18181818 // The information about the Amazon EBS volume.
18191819 Ebs *Ebs `type:"structure"`
18261826 NoDevice *bool `type:"boolean"`
18271827
18281828 // The name of the virtual device, ephemeral0 to ephemeral3.
1829 VirtualName *string `type:"string"`
1829 VirtualName *string `min:"1" type:"string"`
18301830
18311831 metadataBlockDeviceMapping `json:"-" xml:"-"`
18321832 }
18471847
18481848 type CompleteLifecycleActionInput struct {
18491849 // The name of the group for the lifecycle hook.
1850 AutoScalingGroupName *string `type:"string" required:"true"`
1850 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
18511851
18521852 // The action for the group to take. This parameter can be either CONTINUE or
18531853 // ABANDON.
18561856 // A universally unique identifier (UUID) that identifies a specific lifecycle
18571857 // action associated with an instance. Auto Scaling sends this token to the
18581858 // notification target you specified when you created the lifecycle hook.
1859 LifecycleActionToken *string `type:"string" required:"true"`
1859 LifecycleActionToken *string `min:"36" type:"string" required:"true"`
18601860
18611861 // The name of the lifecycle hook.
1862 LifecycleHookName *string `type:"string" required:"true"`
1862 LifecycleHookName *string `min:"1" type:"string" required:"true"`
18631863
18641864 metadataCompleteLifecycleActionInput `json:"-" xml:"-"`
18651865 }
18991899 type CreateAutoScalingGroupInput struct {
19001900 // The name of the group. This name must be unique within the scope of your
19011901 // AWS account.
1902 AutoScalingGroupName *string `type:"string" required:"true"`
1902 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
19031903
19041904 // One or more Availability Zones for the group. This parameter is optional
19051905 // if you specify subnets using the VPCZoneIdentifier parameter.
1906 AvailabilityZones []*string `type:"list"`
1906 AvailabilityZones []*string `min:"1" type:"list"`
19071907
19081908 // The amount of time, in seconds, after a scaling activity completes before
19091909 // another scaling activity can start.
19361936 //
19371937 // By default, health checks use Amazon EC2 instance status checks to determine
19381938 // the health of an instance. For more information, see Health Checks (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/healthcheck.html).
1939 HealthCheckType *string `type:"string"`
1939 HealthCheckType *string `min:"1" type:"string"`
19401940
19411941 // The ID of the EC2 instance used to create a launch configuration for the
19421942 // group. Alternatively, use the LaunchConfigurationName parameter to specify
19501950 // For more information, see Create an Auto Scaling Group from an EC2 Instance
19511951 // (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-asg-from-instance.html)
19521952 // in the Auto Scaling Developer Guide.
1953 InstanceId *string `type:"string"`
1953 InstanceId *string `min:"1" type:"string"`
19541954
19551955 // The name of the launch configuration. Alternatively, use the InstanceId parameter
19561956 // to specify an EC2 instance instead of a launch configuration.
1957 LaunchConfigurationName *string `type:"string"`
1957 LaunchConfigurationName *string `min:"1" type:"string"`
19581958
19591959 // One or more load balancers.
19601960 //
19711971 // The name of the placement group into which you'll launch your instances,
19721972 // if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)
19731973 // in the Amazon Elastic Compute Cloud User Guide.
1974 PlacementGroup *string `type:"string"`
1974 PlacementGroup *string `min:"1" type:"string"`
19751975
19761976 // The tag to be created or updated. Each tag should be defined by its resource
19771977 // type, resource ID, key, value, and a propagate flag. Valid values: key=value,
19981998 // For more information, see Auto Scaling and Amazon Virtual Private Cloud
19991999 // (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html)
20002000 // in the Auto Scaling Developer Guide.
2001 VPCZoneIdentifier *string `type:"string"`
2001 VPCZoneIdentifier *string `min:"1" type:"string"`
20022002
20032003 metadataCreateAutoScalingGroupInput `json:"-" xml:"-"`
20042004 }
20592059 // This parameter is supported only if you are launching EC2-Classic instances.
20602060 // For more information, see ClassicLink (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html)
20612061 // in the Amazon Elastic Compute Cloud User Guide.
2062 ClassicLinkVPCId *string `type:"string"`
2062 ClassicLinkVPCId *string `min:"1" type:"string"`
20632063
20642064 // The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
20652065 // This parameter is required if ClassicLinkVPCId is specified, and is not supported
20852085 // AWS resources. For more information, see Launch Auto Scaling Instances with
20862086 // an IAM Role (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/us-iam-role.html)
20872087 // in the Auto Scaling Developer Guide.
2088 IamInstanceProfile *string `type:"string"`
2088 IamInstanceProfile *string `min:"1" type:"string"`
20892089
20902090 // The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
20912091 // For more information, see Finding an AMI (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html)
20922092 // in the Amazon Elastic Compute Cloud User Guide.
2093 ImageId *string `type:"string"`
2093 ImageId *string `min:"1" type:"string"`
20942094
20952095 // The ID of the EC2 instance to use to create the launch configuration.
20962096 //
21032103 // For more information, see Create a Launch Configuration Using an EC2 Instance
21042104 // (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/create-lc-with-instanceID.html)
21052105 // in the Auto Scaling Developer Guide.
2106 InstanceId *string `type:"string"`
2106 InstanceId *string `min:"1" type:"string"`
21072107
21082108 // Enables detailed monitoring if it is disabled. Detailed monitoring is enabled
21092109 // by default.
21182118 // The instance type of the EC2 instance. For information about available instance
21192119 // types, see Available Instance Types (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes)
21202120 // in the Amazon Elastic Cloud Compute User Guide.
2121 InstanceType *string `type:"string"`
2121 InstanceType *string `min:"1" type:"string"`
21222122
21232123 // The ID of the kernel associated with the AMI.
2124 KernelId *string `type:"string"`
2124 KernelId *string `min:"1" type:"string"`
21252125
21262126 // The name of the key pair. For more information, see Amazon EC2 Key Pairs
21272127 // (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in
21282128 // the Amazon Elastic Compute Cloud User Guide.
2129 KeyName *string `type:"string"`
2129 KeyName *string `min:"1" type:"string"`
21302130
21312131 // The name of the launch configuration. This name must be unique within the
21322132 // scope of your AWS account.
2133 LaunchConfigurationName *string `type:"string" required:"true"`
2133 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
21342134
21352135 // The tenancy of the instance. An instance with a tenancy of dedicated runs
21362136 // on single-tenant hardware and can only be launched into a VPC.
21472147 // in the Auto Scaling Developer Guide.
21482148 //
21492149 // Valid values: default | dedicated
2150 PlacementTenancy *string `type:"string"`
2150 PlacementTenancy *string `min:"1" type:"string"`
21512151
21522152 // The ID of the RAM disk associated with the AMI.
2153 RamdiskId *string `type:"string"`
2153 RamdiskId *string `min:"1" type:"string"`
21542154
21552155 // One or more security groups with which to associate the instances.
21562156 //
21692169 // the current Spot market price. For more information, see Launch Spot Instances
21702170 // in Your Auto Scaling Group (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/US-SpotInstances.html)
21712171 // in the Auto Scaling Developer Guide.
2172 SpotPrice *string `type:"string"`
2172 SpotPrice *string `min:"1" type:"string"`
21732173
21742174 // The user data to make available to the launched EC2 instances. For more information,
21752175 // see Instance Metadata and User Data (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html)
22552255
22562256 type DeleteAutoScalingGroupInput struct {
22572257 // The name of the group to delete.
2258 AutoScalingGroupName *string `type:"string" required:"true"`
2258 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
22592259
22602260 // Specifies that the group will be deleted along with all instances associated
22612261 // with the group, without waiting for all instances to be terminated. This
22992299
23002300 type DeleteLaunchConfigurationInput struct {
23012301 // The name of the launch configuration.
2302 LaunchConfigurationName *string `type:"string" required:"true"`
2302 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
23032303
23042304 metadataDeleteLaunchConfigurationInput `json:"-" xml:"-"`
23052305 }
23382338
23392339 type DeleteLifecycleHookInput struct {
23402340 // The name of the Auto Scaling group for the lifecycle hook.
2341 AutoScalingGroupName *string `type:"string" required:"true"`
2341 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
23422342
23432343 // The name of the lifecycle hook.
2344 LifecycleHookName *string `type:"string" required:"true"`
2344 LifecycleHookName *string `min:"1" type:"string" required:"true"`
23452345
23462346 metadataDeleteLifecycleHookInput `json:"-" xml:"-"`
23472347 }
23802380
23812381 type DeleteNotificationConfigurationInput struct {
23822382 // The name of the Auto Scaling group.
2383 AutoScalingGroupName *string `type:"string" required:"true"`
2383 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
23842384
23852385 // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
23862386 // (SNS) topic.
2387 TopicARN *string `type:"string" required:"true"`
2387 TopicARN *string `min:"1" type:"string" required:"true"`
23882388
23892389 metadataDeleteNotificationConfigurationInput `json:"-" xml:"-"`
23902390 }
24232423
24242424 type DeletePolicyInput struct {
24252425 // The name of the Auto Scaling group.
2426 AutoScalingGroupName *string `type:"string"`
2426 AutoScalingGroupName *string `min:"1" type:"string"`
24272427
24282428 // The name or Amazon Resource Name (ARN) of the policy.
2429 PolicyName *string `type:"string" required:"true"`
2429 PolicyName *string `min:"1" type:"string" required:"true"`
24302430
24312431 metadataDeletePolicyInput `json:"-" xml:"-"`
24322432 }
24652465
24662466 type DeleteScheduledActionInput struct {
24672467 // The name of the Auto Scaling group.
2468 AutoScalingGroupName *string `type:"string"`
2468 AutoScalingGroupName *string `min:"1" type:"string"`
24692469
24702470 // The name of the action to delete.
2471 ScheduledActionName *string `type:"string" required:"true"`
2471 ScheduledActionName *string `min:"1" type:"string" required:"true"`
24722472
24732473 metadataDeleteScheduledActionInput `json:"-" xml:"-"`
24742474 }
28852885
28862886 type DescribeLifecycleHooksInput struct {
28872887 // The name of the group.
2888 AutoScalingGroupName *string `type:"string" required:"true"`
2888 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
28892889
28902890 // The names of one or more lifecycle hooks.
28912891 LifecycleHookNames []*string `type:"list"`
29302930
29312931 type DescribeLoadBalancersInput struct {
29322932 // The name of the group.
2933 AutoScalingGroupName *string `type:"string" required:"true"`
2933 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
29342934
29352935 // The maximum number of items to return with this call.
29362936 MaxRecords *int64 `type:"integer"`
30783078
30793079 type DescribePoliciesInput struct {
30803080 // The name of the group.
3081 AutoScalingGroupName *string `type:"string"`
3081 AutoScalingGroupName *string `min:"1" type:"string"`
30823082
30833083 // The maximum number of items to be returned with each call.
30843084 MaxRecords *int64 `type:"integer"`
31473147 ActivityIds []*string `type:"list"`
31483148
31493149 // The name of the group.
3150 AutoScalingGroupName *string `type:"string"`
3150 AutoScalingGroupName *string `min:"1" type:"string"`
31513151
31523152 // The maximum number of items to return with this call.
31533153 MaxRecords *int64 `type:"integer"`
32393239
32403240 type DescribeScheduledActionsInput struct {
32413241 // The name of the group.
3242 AutoScalingGroupName *string `type:"string"`
3242 AutoScalingGroupName *string `min:"1" type:"string"`
32433243
32443244 // The latest scheduled start time to return. If scheduled action names are
32453245 // provided, this parameter is ignored.
34023402
34033403 type DetachInstancesInput struct {
34043404 // The name of the group.
3405 AutoScalingGroupName *string `type:"string" required:"true"`
3405 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
34063406
34073407 // One or more instance IDs.
34083408 InstanceIds []*string `type:"list"`
34513451
34523452 type DetachLoadBalancersInput struct {
34533453 // The name of the group.
3454 AutoScalingGroupName *string `type:"string"`
3454 AutoScalingGroupName *string `min:"1" type:"string"`
34553455
34563456 // One or more load balancer names.
34573457 LoadBalancerNames []*string `type:"list"`
34933493
34943494 type DisableMetricsCollectionInput struct {
34953495 // The name or Amazon Resource Name (ARN) of the group.
3496 AutoScalingGroupName *string `type:"string" required:"true"`
3496 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
34973497
34983498 // One or more metrics. If you omit this parameter, all metrics are disabled.
34993499 //
35623562 // Valid values: Range is 100 to 4000.
35633563 //
35643564 // Default: None
3565 Iops *int64 `type:"integer"`
3565 Iops *int64 `min:"100" type:"integer"`
35663566
35673567 // The ID of the snapshot.
3568 SnapshotId *string `type:"string"`
3568 SnapshotId *string `min:"1" type:"string"`
35693569
35703570 // The volume size, in gigabytes.
35713571 //
35773577 // volume size, the default is the size of the snapshot.
35783578 //
35793579 // Required: Required when the volume type is io1.
3580 VolumeSize *int64 `type:"integer"`
3580 VolumeSize *int64 `min:"1" type:"integer"`
35813581
35823582 // The volume type.
35833583 //
35843584 // Valid values: standard | io1 | gp2
35853585 //
35863586 // Default: standard
3587 VolumeType *string `type:"string"`
3587 VolumeType *string `min:"1" type:"string"`
35883588
35893589 metadataEbs `json:"-" xml:"-"`
35903590 }
36053605
36063606 type EnableMetricsCollectionInput struct {
36073607 // The name or ARN of the Auto Scaling group.
3608 AutoScalingGroupName *string `type:"string" required:"true"`
3608 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
36093609
36103610 // The granularity to associate with the metrics to collect. The only valid
36113611 // value is 1Minute.
3612 Granularity *string `type:"string" required:"true"`
3612 Granularity *string `min:"1" type:"string" required:"true"`
36133613
36143614 // One or more metrics. If you omit this parameter, all metrics are enabled.
36153615 //
36713671 // Describes an enabled metric.
36723672 type EnabledMetric struct {
36733673 // The granularity of the metric. The only valid value is 1Minute.
3674 Granularity *string `type:"string"`
3674 Granularity *string `min:"1" type:"string"`
36753675
36763676 // The name of the metric.
36773677 //
36903690 // GroupTerminatingInstances
36913691 //
36923692 // GroupTotalInstances
3693 Metric *string `type:"string"`
3693 Metric *string `min:"1" type:"string"`
36943694
36953695 metadataEnabledMetric `json:"-" xml:"-"`
36963696 }
37113711
37123712 type EnterStandbyInput struct {
37133713 // The name of the Auto Scaling group.
3714 AutoScalingGroupName *string `type:"string" required:"true"`
3714 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
37153715
37163716 // One or more instances to move into Standby mode. You must specify at least
37173717 // one instance ID.
37633763
37643764 type ExecutePolicyInput struct {
37653765 // The name or Amazon Resource Name (ARN) of the Auto Scaling group.
3766 AutoScalingGroupName *string `type:"string"`
3766 AutoScalingGroupName *string `min:"1" type:"string"`
37673767
37683768 // The breach threshold for the alarm.
37693769 //
37953795 MetricValue *float64 `type:"double"`
37963796
37973797 // The name or ARN of the policy.
3798 PolicyName *string `type:"string" required:"true"`
3798 PolicyName *string `min:"1" type:"string" required:"true"`
37993799
38003800 metadataExecutePolicyInput `json:"-" xml:"-"`
38013801 }
38343834
38353835 type ExitStandbyInput struct {
38363836 // The name of the Auto Scaling group.
3837 AutoScalingGroupName *string `type:"string" required:"true"`
3837 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
38383838
38393839 // One or more instance IDs. You must specify at least one instance ID.
38403840 InstanceIds []*string `type:"list"`
39063906 // Describes an Auto Scaling group.
39073907 type Group struct {
39083908 // The Amazon Resource Name (ARN) of the group.
3909 AutoScalingGroupARN *string `type:"string"`
3909 AutoScalingGroupARN *string `min:"1" type:"string"`
39103910
39113911 // The name of the group.
3912 AutoScalingGroupName *string `type:"string" required:"true"`
3912 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
39133913
39143914 // One or more Availability Zones for the group.
3915 AvailabilityZones []*string `type:"list" required:"true"`
3915 AvailabilityZones []*string `min:"1" type:"list" required:"true"`
39163916
39173917 // The date and time the group was created.
39183918 CreatedTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
39333933
39343934 // The service of interest for the health status check, which can be either
39353935 // EC2 for Amazon EC2 or ELB for Elastic Load Balancing.
3936 HealthCheckType *string `type:"string" required:"true"`
3936 HealthCheckType *string `min:"1" type:"string" required:"true"`
39373937
39383938 // The EC2 instances associated with the group.
39393939 Instances []*Instance `type:"list"`
39403940
39413941 // The name of the associated launch configuration.
3942 LaunchConfigurationName *string `type:"string" required:"true"`
3942 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
39433943
39443944 // One or more load balancers associated with the group.
39453945 LoadBalancerNames []*string `type:"list"`
39523952
39533953 // The name of the placement group into which you'll launch your instances,
39543954 // if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html).
3955 PlacementGroup *string `type:"string"`
3955 PlacementGroup *string `min:"1" type:"string"`
39563956
39573957 // The current state of the group when DeleteAutoScalingGroup is in progress.
3958 Status *string `type:"string"`
3958 Status *string `min:"1" type:"string"`
39593959
39603960 // The suspended processes associated with the group.
39613961 SuspendedProcesses []*SuspendedProcess `type:"list"`
39703970 //
39713971 // If you specify VPCZoneIdentifier and AvailabilityZones, ensure that the
39723972 // Availability Zones of the subnets match the values for AvailabilityZones.
3973 VPCZoneIdentifier *string `type:"string"`
3973 VPCZoneIdentifier *string `min:"1" type:"string"`
39743974
39753975 metadataGroup `json:"-" xml:"-"`
39763976 }
39923992 // Describes an EC2 instance.
39933993 type Instance struct {
39943994 // The Availability Zone in which the instance is running.
3995 AvailabilityZone *string `type:"string" required:"true"`
3995 AvailabilityZone *string `min:"1" type:"string" required:"true"`
39963996
39973997 // The health status of the instance.
3998 HealthStatus *string `type:"string" required:"true"`
3998 HealthStatus *string `min:"1" type:"string" required:"true"`
39993999
40004000 // The ID of the instance.
4001 InstanceId *string `type:"string" required:"true"`
4001 InstanceId *string `min:"1" type:"string" required:"true"`
40024002
40034003 // The launch configuration associated with the instance.
4004 LaunchConfigurationName *string `type:"string" required:"true"`
4004 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
40054005
40064006 // A description of the current lifecycle state. Note that the Quarantined state
40074007 // is not used.
40274027 // Describes an EC2 instance associated with an Auto Scaling group.
40284028 type InstanceDetails struct {
40294029 // The name of the Auto Scaling group associated with the instance.
4030 AutoScalingGroupName *string `type:"string" required:"true"`
4030 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
40314031
40324032 // The Availability Zone for the instance.
4033 AvailabilityZone *string `type:"string" required:"true"`
4033 AvailabilityZone *string `min:"1" type:"string" required:"true"`
40344034
40354035 // The health status of this instance. "Healthy" means that the instance is
40364036 // healthy and should remain in service. "Unhealthy" means that the instance
40374037 // is unhealthy and Auto Scaling should terminate and replace it.
4038 HealthStatus *string `type:"string" required:"true"`
4038 HealthStatus *string `min:"1" type:"string" required:"true"`
40394039
40404040 // The ID of the instance.
4041 InstanceId *string `type:"string" required:"true"`
4041 InstanceId *string `min:"1" type:"string" required:"true"`
40424042
40434043 // The launch configuration associated with the instance.
4044 LaunchConfigurationName *string `type:"string" required:"true"`
4044 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
40454045
40464046 // The lifecycle state for the instance. For more information, see Auto Scaling
40474047 // Instance States (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html#AutoScalingStates)
40484048 // in the Auto Scaling Developer Guide.
4049 LifecycleState *string `type:"string" required:"true"`
4049 LifecycleState *string `min:"1" type:"string" required:"true"`
40504050
40514051 metadataInstanceDetails `json:"-" xml:"-"`
40524052 }
41004100 // This parameter can only be used if you are launching EC2-Classic instances.
41014101 // For more information, see ClassicLink (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html)
41024102 // in the Amazon Elastic Compute Cloud User Guide.
4103 ClassicLinkVPCId *string `type:"string"`
4103 ClassicLinkVPCId *string `min:"1" type:"string"`
41044104
41054105 // The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.
41064106 // This parameter is required if ClassicLinkVPCId is specified, and cannot be
41164116
41174117 // The name or Amazon Resource Name (ARN) of the instance profile associated
41184118 // with the IAM role for the instance.
4119 IamInstanceProfile *string `type:"string"`
4119 IamInstanceProfile *string `min:"1" type:"string"`
41204120
41214121 // The ID of the Amazon Machine Image (AMI).
4122 ImageId *string `type:"string" required:"true"`
4122 ImageId *string `min:"1" type:"string" required:"true"`
41234123
41244124 // Controls whether instances in this group are launched with detailed monitoring.
41254125 InstanceMonitoring *InstanceMonitoring `type:"structure"`
41264126
41274127 // The instance type for the instances.
4128 InstanceType *string `type:"string" required:"true"`
4128 InstanceType *string `min:"1" type:"string" required:"true"`
41294129
41304130 // The ID of the kernel associated with the AMI.
4131 KernelId *string `type:"string"`
4131 KernelId *string `min:"1" type:"string"`
41324132
41334133 // The name of the key pair.
4134 KeyName *string `type:"string"`
4134 KeyName *string `min:"1" type:"string"`
41354135
41364136 // The Amazon Resource Name (ARN) of the launch configuration.
4137 LaunchConfigurationARN *string `type:"string"`
4137 LaunchConfigurationARN *string `min:"1" type:"string"`
41384138
41394139 // The name of the launch configuration.
4140 LaunchConfigurationName *string `type:"string" required:"true"`
4140 LaunchConfigurationName *string `min:"1" type:"string" required:"true"`
41414141
41424142 // The tenancy of the instance, either default or dedicated. An instance with
41434143 // dedicated tenancy runs in an isolated, single-tenant hardware and can only
41444144 // be launched into a VPC.
4145 PlacementTenancy *string `type:"string"`
4145 PlacementTenancy *string `min:"1" type:"string"`
41464146
41474147 // The ID of the RAM disk associated with the AMI.
4148 RamdiskId *string `type:"string"`
4148 RamdiskId *string `min:"1" type:"string"`
41494149
41504150 // The security groups to associate with the instances.
41514151 SecurityGroups []*string `type:"list"`
41524152
41534153 // The price to bid when launching Spot Instances.
4154 SpotPrice *string `type:"string"`
4154 SpotPrice *string `min:"1" type:"string"`
41554155
41564156 // The user data available to the instances.
41574157 UserData *string `type:"string"`
41844184 // in the Auto Scaling Developer Guide.
41854185 type LifecycleHook struct {
41864186 // The name of the Auto Scaling group for the lifecycle hook.
4187 AutoScalingGroupName *string `type:"string"`
4187 AutoScalingGroupName *string `min:"1" type:"string"`
41884188
41894189 // Defines the action the Auto Scaling group should take when the lifecycle
41904190 // hook timeout elapses or if an unexpected failure occurs. The valid values
42024202 HeartbeatTimeout *int64 `type:"integer"`
42034203
42044204 // The name of the lifecycle hook.
4205 LifecycleHookName *string `type:"string"`
4205 LifecycleHookName *string `min:"1" type:"string"`
42064206
42074207 // The state of the EC2 instance to which you want to attach the lifecycle hook.
42084208 // For a list of lifecycle hook types, see DescribeLifecycleHookTypes.
42104210
42114211 // Additional information that you want to include any time Auto Scaling sends
42124212 // a message to the notification target.
4213 NotificationMetadata *string `type:"string"`
4213 NotificationMetadata *string `min:"1" type:"string"`
42144214
42154215 // The ARN of the notification target that Auto Scaling uses to notify you when
42164216 // an instance is in the transition state for the lifecycle hook. This ARN target
42194219 //
42204220 // Lifecycle action token User account ID Name of the Auto Scaling group Lifecycle
42214221 // hook name EC2 instance ID Lifecycle transition Notification metadata
4222 NotificationTargetARN *string `type:"string"`
4222 NotificationTargetARN *string `min:"1" type:"string"`
42234223
42244224 // The ARN of the IAM role that allows the Auto Scaling group to publish to
42254225 // the specified notification target.
4226 RoleARN *string `type:"string"`
4226 RoleARN *string `min:"1" type:"string"`
42274227
42284228 metadataLifecycleHook `json:"-" xml:"-"`
42294229 }
42454245 // Describes the state of a load balancer.
42464246 type LoadBalancerState struct {
42474247 // The name of the load balancer.
4248 LoadBalancerName *string `type:"string"`
4248 LoadBalancerName *string `min:"1" type:"string"`
42494249
42504250 // The state of the load balancer.
42514251 //
42594259 // Removing - The instances are being deregistered from the load balancer.
42604260 // If connection draining is enabled, Elastic Load Balancing waits for in-flight
42614261 // requests to complete before deregistering the instances.
4262 State *string `type:"string"`
4262 State *string `min:"1" type:"string"`
42634263
42644264 metadataLoadBalancerState `json:"-" xml:"-"`
42654265 }
42974297 // GroupTerminatingInstances
42984298 //
42994299 // GroupTotalInstances
4300 Metric *string `type:"string"`
4300 Metric *string `min:"1" type:"string"`
43014301
43024302 metadataMetricCollectionType `json:"-" xml:"-"`
43034303 }
43194319 // Describes a granularity of a metric.
43204320 type MetricGranularityType struct {
43214321 // The granularity. The only valid value is 1Minute.
4322 Granularity *string `type:"string"`
4322 Granularity *string `min:"1" type:"string"`
43234323
43244324 metadataMetricGranularityType `json:"-" xml:"-"`
43254325 }
43414341 // Describes a notification.
43424342 type NotificationConfiguration struct {
43434343 // The name of the group.
4344 AutoScalingGroupName *string `type:"string"`
4344 AutoScalingGroupName *string `min:"1" type:"string"`
43454345
43464346 // The types of events for an action to start.
43474347 //
43544354 // autoscaling:EC2_INSTANCE_TERMINATE_ERROR
43554355 //
43564356 // autoscaling:TEST_NOTIFICATION
4357 NotificationType *string `type:"string"`
4357 NotificationType *string `min:"1" type:"string"`
43584358
43594359 // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
43604360 // (SNS) topic.
4361 TopicARN *string `type:"string"`
4361 TopicARN *string `min:"1" type:"string"`
43624362
43634363 metadataNotificationConfiguration `json:"-" xml:"-"`
43644364 }
43994399 // ReplaceUnhealthy
44004400 //
44014401 // ScheduledActions
4402 ProcessName *string `type:"string" required:"true"`
4402 ProcessName *string `min:"1" type:"string" required:"true"`
44034403
44044404 metadataProcessType `json:"-" xml:"-"`
44054405 }
44214421 type PutLifecycleHookInput struct {
44224422 // The name of the Auto Scaling group to which you want to assign the lifecycle
44234423 // hook.
4424 AutoScalingGroupName *string `type:"string" required:"true"`
4424 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
44254425
44264426 // Defines the action the Auto Scaling group should take when the lifecycle
44274427 // hook timeout elapses or if an unexpected failure occurs. The value for this
44374437 HeartbeatTimeout *int64 `type:"integer"`
44384438
44394439 // The name of the lifecycle hook.
4440 LifecycleHookName *string `type:"string" required:"true"`
4440 LifecycleHookName *string `min:"1" type:"string" required:"true"`
44414441
44424442 // The instance state to which you want to attach the lifecycle hook. For a
44434443 // list of lifecycle hook types, see DescribeLifecycleHookTypes.
44484448
44494449 // Contains additional information that you want to include any time Auto Scaling
44504450 // sends a message to the notification target.
4451 NotificationMetadata *string `type:"string"`
4451 NotificationMetadata *string `min:"1" type:"string"`
44524452
44534453 // The ARN of the notification target that Auto Scaling will use to notify you
44544454 // when an instance is in the transition state for the lifecycle hook. This
44694469 //
44704470 // When you call this operation, a test message is sent to the notification
44714471 // target. This test message contains an additional key/value pair: Event:autoscaling:TEST_NOTIFICATION.
4472 NotificationTargetARN *string `type:"string"`
4472 NotificationTargetARN *string `min:"1" type:"string"`
44734473
44744474 // The ARN of the IAM role that allows the Auto Scaling group to publish to
44754475 // the specified notification target.
44764476 //
44774477 // This parameter is required for new lifecycle hooks, but optional when updating
44784478 // existing hooks.
4479 RoleARN *string `type:"string"`
4479 RoleARN *string `min:"1" type:"string"`
44804480
44814481 metadataPutLifecycleHookInput `json:"-" xml:"-"`
44824482 }
45154515
45164516 type PutNotificationConfigurationInput struct {
45174517 // The name of the Auto Scaling group.
4518 AutoScalingGroupName *string `type:"string" required:"true"`
4518 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
45194519
45204520 // The type of event that will cause the notification to be sent. For details
45214521 // about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.
45234523
45244524 // The Amazon Resource Name (ARN) of the Amazon Simple Notification Service
45254525 // (SNS) topic.
4526 TopicARN *string `type:"string" required:"true"`
4526 TopicARN *string `min:"1" type:"string" required:"true"`
45274527
45284528 metadataPutNotificationConfigurationInput `json:"-" xml:"-"`
45294529 }
45664566 //
45674567 // For more information, see Dynamic Scaling (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-scale-based-on-demand.html)
45684568 // in the Auto Scaling Developer Guide.
4569 AdjustmentType *string `type:"string" required:"true"`
4569 AdjustmentType *string `min:"1" type:"string" required:"true"`
45704570
45714571 // The name or ARN of the group.
4572 AutoScalingGroupName *string `type:"string" required:"true"`
4572 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
45734573
45744574 // The amount of time, in seconds, after a scaling activity completes and before
45754575 // the next scaling activity can start. If this parameter is not specified,
45934593 // as Average.
45944594 //
45954595 // This parameter is not supported if the policy type is SimpleScaling.
4596 MetricAggregationType *string `type:"string"`
4596 MetricAggregationType *string `min:"1" type:"string"`
45974597
45984598 // The minimum number of instances to scale. If the value of AdjustmentType
45994599 // is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity
46054605 MinAdjustmentStep *int64 `type:"integer"`
46064606
46074607 // The name of the policy.
4608 PolicyName *string `type:"string" required:"true"`
4608 PolicyName *string `min:"1" type:"string" required:"true"`
46094609
46104610 // The policy type. Valid values are SimpleScaling and StepScaling. If the policy
46114611 // type is null, the value is treated as SimpleScaling.
4612 PolicyType *string `type:"string"`
4612 PolicyType *string `min:"1" type:"string"`
46134613
46144614 // The amount by which to scale, based on the specified adjustment type. A positive
46154615 // value adds to the current capacity while a negative number removes from the
46454645
46464646 type PutScalingPolicyOutput struct {
46474647 // The Amazon Resource Name (ARN) of the policy.
4648 PolicyARN *string `type:"string"`
4648 PolicyARN *string `min:"1" type:"string"`
46494649
46504650 metadataPutScalingPolicyOutput `json:"-" xml:"-"`
46514651 }
46664666
46674667 type PutScheduledUpdateGroupActionInput struct {
46684668 // The name or Amazon Resource Name (ARN) of the Auto Scaling group.
4669 AutoScalingGroupName *string `type:"string" required:"true"`
4669 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
46704670
46714671 // The number of EC2 instances that should be running in the group.
46724672 DesiredCapacity *int64 `type:"integer"`
46864686 //
46874687 // When StartTime and EndTime are specified with Recurrence, they form the
46884688 // boundaries of when the recurring action will start and stop.
4689 Recurrence *string `type:"string"`
4689 Recurrence *string `min:"1" type:"string"`
46904690
46914691 // The name of this scaling action.
4692 ScheduledActionName *string `type:"string" required:"true"`
4692 ScheduledActionName *string `min:"1" type:"string" required:"true"`
46934693
46944694 // The time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT
46954695 // only (for example, 2014-06-01T00:00:00Z).
47444744
47454745 type RecordLifecycleActionHeartbeatInput struct {
47464746 // The name of the Auto Scaling group for the hook.
4747 AutoScalingGroupName *string `type:"string" required:"true"`
4747 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
47484748
47494749 // A token that uniquely identifies a specific lifecycle action associated with
47504750 // an instance. Auto Scaling sends this token to the notification target you
47514751 // specified when you created the lifecycle hook.
4752 LifecycleActionToken *string `type:"string" required:"true"`
4752 LifecycleActionToken *string `min:"36" type:"string" required:"true"`
47534753
47544754 // The name of the lifecycle hook.
4755 LifecycleHookName *string `type:"string" required:"true"`
4755 LifecycleHookName *string `min:"1" type:"string" required:"true"`
47564756
47574757 metadataRecordLifecycleActionHeartbeatInput `json:"-" xml:"-"`
47584758 }
48114811 type ScalingPolicy struct {
48124812 // The adjustment type, which specifies how ScalingAdjustment is interpreted.
48134813 // Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
4814 AdjustmentType *string `type:"string"`
4814 AdjustmentType *string `min:"1" type:"string"`
48154815
48164816 // The CloudWatch alarms related to the policy.
48174817 Alarms []*Alarm `type:"list"`
48184818
48194819 // The name of the Auto Scaling group associated with this scaling policy.
4820 AutoScalingGroupName *string `type:"string"`
4820 AutoScalingGroupName *string `min:"1" type:"string"`
48214821
48224822 // The amount of time, in seconds, after a scaling activity completes before
48234823 // any further trigger-related scaling activities can start.
48294829
48304830 // The aggregation type for the CloudWatch metrics. Valid values are Minimum,
48314831 // Maximum, and Average.
4832 MetricAggregationType *string `type:"string"`
4832 MetricAggregationType *string `min:"1" type:"string"`
48334833
48344834 // The minimum number of instances to scale. If the value of AdjustmentType
48354835 // is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity
48414841 MinAdjustmentStep *int64 `type:"integer"`
48424842
48434843 // The Amazon Resource Name (ARN) of the policy.
4844 PolicyARN *string `type:"string"`
4844 PolicyARN *string `min:"1" type:"string"`
48454845
48464846 // The name of the scaling policy.
4847 PolicyName *string `type:"string"`
4847 PolicyName *string `min:"1" type:"string"`
48484848
48494849 // The policy type. Valid values are SimpleScaling and StepScaling.
4850 PolicyType *string `type:"string"`
4850 PolicyType *string `min:"1" type:"string"`
48514851
48524852 // The amount by which to scale, based on the specified adjustment type. A positive
48534853 // value adds to the current capacity while a negative number removes from the
48774877
48784878 type ScalingProcessQuery struct {
48794879 // The name or Amazon Resource Name (ARN) of the Auto Scaling group.
4880 AutoScalingGroupName *string `type:"string" required:"true"`
4880 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
48814881
48824882 // One or more of the following processes:
48834883 //
49184918 // Describes a scheduled update to an Auto Scaling group.
49194919 type ScheduledUpdateGroupAction struct {
49204920 // The name of the group.
4921 AutoScalingGroupName *string `type:"string"`
4921 AutoScalingGroupName *string `min:"1" type:"string"`
49224922
49234923 // The number of instances you prefer to maintain in the group.
49244924 DesiredCapacity *int64 `type:"integer"`
49344934 MinSize *int64 `type:"integer"`
49354935
49364936 // The recurring schedule for the action.
4937 Recurrence *string `type:"string"`
4937 Recurrence *string `min:"1" type:"string"`
49384938
49394939 // The Amazon Resource Name (ARN) of the scheduled action.
4940 ScheduledActionARN *string `type:"string"`
4940 ScheduledActionARN *string `min:"1" type:"string"`
49414941
49424942 // The name of the scheduled action.
4943 ScheduledActionName *string `type:"string"`
4943 ScheduledActionName *string `min:"1" type:"string"`
49444944
49454945 // The date and time that the action is scheduled to begin. This date and time
49464946 // can be up to one month in the future.
49714971
49724972 type SetDesiredCapacityInput struct {
49734973 // The name of the Auto Scaling group.
4974 AutoScalingGroupName *string `type:"string" required:"true"`
4974 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
49754975
49764976 // The number of EC2 instances that should be running in the Auto Scaling group.
49774977 DesiredCapacity *int64 `type:"integer" required:"true"`
50215021 // The health status of the instance. Set to Healthy if you want the instance
50225022 // to remain in service. Set to Unhealthy if you want the instance to be out
50235023 // of service. Auto Scaling will terminate and replace the unhealthy instance.
5024 HealthStatus *string `type:"string" required:"true"`
5024 HealthStatus *string `min:"1" type:"string" required:"true"`
50255025
50265026 // The ID of the EC2 instance.
5027 InstanceId *string `type:"string" required:"true"`
5027 InstanceId *string `min:"1" type:"string" required:"true"`
50285028
50295029 // If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod
50305030 // specified for the group, by default, this call will respect the grace period.
51605160 // see ProcessType.
51615161 type SuspendedProcess struct {
51625162 // The name of the suspended process.
5163 ProcessName *string `type:"string"`
5163 ProcessName *string `min:"1" type:"string"`
51645164
51655165 // The reason that the process was suspended.
5166 SuspensionReason *string `type:"string"`
5166 SuspensionReason *string `min:"1" type:"string"`
51675167
51685168 metadataSuspendedProcess `json:"-" xml:"-"`
51695169 }
51855185 // Describes a tag for an Auto Scaling group.
51865186 type Tag struct {
51875187 // The tag key.
5188 Key *string `type:"string" required:"true"`
5188 Key *string `min:"1" type:"string" required:"true"`
51895189
51905190 // Determines whether the tag is added to new instances as they are launched
51915191 // in the group.
52205220 // Describes a tag for an Auto Scaling group.
52215221 type TagDescription struct {
52225222 // The tag key.
5223 Key *string `type:"string"`
5223 Key *string `min:"1" type:"string"`
52245224
52255225 // Determines whether the tag is added to new instances as they are launched
52265226 // in the group.
52545254
52555255 type TerminateInstanceInAutoScalingGroupInput struct {
52565256 // The ID of the EC2 instance.
5257 InstanceId *string `type:"string" required:"true"`
5257 InstanceId *string `min:"1" type:"string" required:"true"`
52585258
52595259 // If true, terminating this instance also decrements the size of the Auto Scaling
52605260 // group.
53005300
53015301 type UpdateAutoScalingGroupInput struct {
53025302 // The name of the Auto Scaling group.
5303 AutoScalingGroupName *string `type:"string" required:"true"`
5303 AutoScalingGroupName *string `min:"1" type:"string" required:"true"`
53045304
53055305 // One or more Availability Zones for the group.
5306 AvailabilityZones []*string `type:"list"`
5306 AvailabilityZones []*string `min:"1" type:"list"`
53075307
53085308 // The amount of time, in seconds, after a scaling activity completes before
53095309 // another scaling activity can start. For more information, see Understanding
53245324 // The type of health check for the instances in the Auto Scaling group. The
53255325 // health check type can either be EC2 for Amazon EC2 or ELB for Elastic Load
53265326 // Balancing.
5327 HealthCheckType *string `type:"string"`
5327 HealthCheckType *string `min:"1" type:"string"`
53285328
53295329 // The name of the launch configuration.
5330 LaunchConfigurationName *string `type:"string"`
5330 LaunchConfigurationName *string `min:"1" type:"string"`
53315331
53325332 // The maximum size of the Auto Scaling group.
53335333 MaxSize *int64 `type:"integer"`
53375337
53385338 // The name of the placement group into which you'll launch your instances,
53395339 // if any. For more information, see Placement Groups (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html).
5340 PlacementGroup *string `type:"string"`
5340 PlacementGroup *string `min:"1" type:"string"`
53415341
53425342 // A standalone termination policy or a list of termination policies used to
53435343 // select the instance to terminate. The policies are executed in the order
53575357 // For more information, see Auto Scaling and Amazon Virtual Private Cloud
53585358 // (http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/autoscalingsubnets.html)
53595359 // in the Auto Scaling Developer Guide.
5360 VPCZoneIdentifier *string `type:"string"`
5360 VPCZoneIdentifier *string `min:"1" type:"string"`
53615361
53625362 metadataUpdateAutoScalingGroupInput `json:"-" xml:"-"`
53635363 }
+33
-33
service/cloudformation/api.go less more
686686 // Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
687687 // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody
688688 // or the StackPolicyURL parameter, but not both.
689 StackPolicyBody *string `type:"string"`
689 StackPolicyBody *string `min:"1" type:"string"`
690690
691691 // Location of a file containing the stack policy. The URL must point to a policy
692692 // (max size: 16KB) located in an S3 bucket in the same region as the stack.
693693 // You can specify either the StackPolicyBody or the StackPolicyURL parameter,
694694 // but not both.
695 StackPolicyURL *string `type:"string"`
695 StackPolicyURL *string `min:"1" type:"string"`
696696
697697 // A set of user-defined Tags to associate with this stack, represented by key/value
698698 // pairs. Tags defined for the stack are propagated to EC2 resources that are
706706 //
707707 // Conditional: You must specify either the TemplateBody or the TemplateURL
708708 // parameter, but not both.
709 TemplateBody *string `type:"string"`
709 TemplateBody *string `min:"1" type:"string"`
710710
711711 // Location of file containing the template body. The URL must point to a template
712712 // (max size: 460,800 bytes) located in an S3 bucket in the same region as the
715715 //
716716 // Conditional: You must specify either the TemplateBody or the TemplateURL
717717 // parameter, but not both.
718 TemplateURL *string `type:"string"`
718 TemplateURL *string `min:"1" type:"string"`
719719
720720 // The amount of time that can pass before the stack status becomes CREATE_FAILED;
721721 // if DisableRollback is not set or is set to false, the stack will be rolled
722722 // back.
723 TimeoutInMinutes *int64 `type:"integer"`
723 TimeoutInMinutes *int64 `min:"1" type:"integer"`
724724
725725 metadataCreateStackInput `json:"-" xml:"-"`
726726 }
807807 // one.
808808 //
809809 // Default: There is no default value.
810 NextToken *string `type:"string"`
810 NextToken *string `min:"1" type:"string"`
811811
812812 // The name or the unique stack ID that is associated with the stack, which
813813 // are not always interchangeable:
838838 type DescribeStackEventsOutput struct {
839839 // String that identifies the start of the next list of events, if there is
840840 // one.
841 NextToken *string `type:"string"`
841 NextToken *string `min:"1" type:"string"`
842842
843843 // A list of StackEvents structures.
844844 StackEvents []*StackEvent `type:"list"`
990990 type DescribeStacksInput struct {
991991 // String that identifies the start of the next list of stacks, if there is
992992 // one.
993 NextToken *string `type:"string"`
993 NextToken *string `min:"1" type:"string"`
994994
995995 // The name or the unique stack ID that is associated with the stack, which
996996 // are not always interchangeable:
10211021 type DescribeStacksOutput struct {
10221022 // String that identifies the start of the next list of stacks, if there is
10231023 // one.
1024 NextToken *string `type:"string"`
1024 NextToken *string `min:"1" type:"string"`
10251025
10261026 // A list of stack structures.
10271027 Stacks []*Stack `type:"list"`
10541054 //
10551055 // Conditional: You must pass TemplateBody or TemplateURL. If both are passed,
10561056 // only TemplateBody is used.
1057 TemplateBody *string `type:"string"`
1057 TemplateBody *string `min:"1" type:"string"`
10581058
10591059 // Location of file containing the template body. The URL must point to a template
10601060 // located in an S3 bucket in the same region as the stack. For more information,
10631063 //
10641064 // Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
10651065 // only TemplateBody is used.
1066 TemplateURL *string `type:"string"`
1066 TemplateURL *string `min:"1" type:"string"`
10671067
10681068 metadataEstimateTemplateCostInput `json:"-" xml:"-"`
10691069 }
11331133 // Structure containing the stack policy body. (For more information, go to
11341134 // Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
11351135 // in the AWS CloudFormation User Guide.)
1136 StackPolicyBody *string `type:"string"`
1136 StackPolicyBody *string `min:"1" type:"string"`
11371137
11381138 metadataGetStackPolicyOutput `json:"-" xml:"-"`
11391139 }
11841184 // Structure containing the template body. (For more information, go to Template
11851185 // Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
11861186 // in the AWS CloudFormation User Guide.)
1187 TemplateBody *string `type:"string"`
1187 TemplateBody *string `min:"1" type:"string"`
11881188
11891189 metadataGetTemplateOutput `json:"-" xml:"-"`
11901190 }
12121212 //
12131213 // Conditional: You must specify only one of the following parameters: StackName,
12141214 // TemplateBody, or TemplateURL.
1215 StackName *string `type:"string"`
1215 StackName *string `min:"1" type:"string"`
12161216
12171217 // Structure containing the template body with a minimum length of 1 byte and
12181218 // a maximum length of 51,200 bytes. For more information about templates, see
12211221 //
12221222 // Conditional: You must specify only one of the following parameters: StackName,
12231223 // TemplateBody, or TemplateURL.
1224 TemplateBody *string `type:"string"`
1224 TemplateBody *string `min:"1" type:"string"`
12251225
12261226 // Location of file containing the template body. The URL must point to a template
12271227 // (max size: 460,800 bytes) located in an Amazon S3 bucket. For more information
12301230 //
12311231 // Conditional: You must specify only one of the following parameters: StackName,
12321232 // TemplateBody, or TemplateURL.
1233 TemplateURL *string `type:"string"`
1233 TemplateURL *string `min:"1" type:"string"`
12341234
12351235 metadataGetTemplateSummaryInput `json:"-" xml:"-"`
12361236 }
12991299 // if there is one.
13001300 //
13011301 // Default: There is no default value.
1302 NextToken *string `type:"string"`
1302 NextToken *string `min:"1" type:"string"`
13031303
13041304 // The name or the unique stack ID that is associated with the stack, which
13051305 // are not always interchangeable:
13301330 type ListStackResourcesOutput struct {
13311331 // String that identifies the start of the next list of stack resources, if
13321332 // there is one.
1333 NextToken *string `type:"string"`
1333 NextToken *string `min:"1" type:"string"`
13341334
13351335 // A list of StackResourceSummary structures.
13361336 StackResourceSummaries []*StackResourceSummary `type:"list"`
13581358 // one.
13591359 //
13601360 // Default: There is no default value.
1361 NextToken *string `type:"string"`
1361 NextToken *string `min:"1" type:"string"`
13621362
13631363 // Stack status to use as a filter. Specify one or more stack status codes to
13641364 // list only stacks with the specified status codes. For a complete list of
13861386 type ListStacksOutput struct {
13871387 // String that identifies the start of the next list of stacks, if there is
13881388 // one.
1389 NextToken *string `type:"string"`
1389 NextToken *string `min:"1" type:"string"`
13901390
13911391 // A list of StackSummary structures containing information about the specified
13921392 // stacks.
15401540 // Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
15411541 // in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody
15421542 // or the StackPolicyURL parameter, but not both.
1543 StackPolicyBody *string `type:"string"`
1543 StackPolicyBody *string `min:"1" type:"string"`
15441544
15451545 // Location of a file containing the stack policy. The URL must point to a policy
15461546 // (max size: 16KB) located in an S3 bucket in the same region as the stack.
15471547 // You can specify either the StackPolicyBody or the StackPolicyURL parameter,
15481548 // but not both.
1549 StackPolicyURL *string `type:"string"`
1549 StackPolicyURL *string `min:"1" type:"string"`
15501550
15511551 metadataSetStackPolicyInput `json:"-" xml:"-"`
15521552 }
15911591
15921592 // The stack name or unique stack ID that includes the resource that you want
15931593 // to signal.
1594 StackName *string `type:"string" required:"true"`
1594 StackName *string `min:"1" type:"string" required:"true"`
15951595
15961596 // The status of the signal, which is either success or failure. A failure signal
15971597 // causes AWS CloudFormation to immediately fail the stack creation or update.
16011601 // groups, specify the instance ID that you are signaling as the unique ID.
16021602 // If you send multiple signals to a single resource (such as signaling a wait
16031603 // condition), each signal requires a different unique ID.
1604 UniqueId *string `type:"string" required:"true"`
1604 UniqueId *string `min:"1" type:"string" required:"true"`
16051605
16061606 metadataSignalResourceInput `json:"-" xml:"-"`
16071607 }
16831683 Tags []*Tag `type:"list"`
16841684
16851685 // The amount of time within which stack creation should complete.
1686 TimeoutInMinutes *int64 `type:"integer"`
1686 TimeoutInMinutes *int64 `min:"1" type:"integer"`
16871687
16881688 metadataStack `json:"-" xml:"-"`
16891689 }
20392039 // You might update the stack policy, for example, in order to protect a new
20402040 // resource that you created during a stack update. If you do not specify a
20412041 // stack policy, the current policy that is associated with the stack is unchanged.
2042 StackPolicyBody *string `type:"string"`
2042 StackPolicyBody *string `min:"1" type:"string"`
20432043
20442044 // Structure containing the temporary overriding stack policy body. You can
20452045 // specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL
20482048 // If you want to update protected resources, specify a temporary overriding
20492049 // stack policy during this update. If you do not specify a stack policy, the
20502050 // current policy that is associated with the stack will be used.
2051 StackPolicyDuringUpdateBody *string `type:"string"`
2051 StackPolicyDuringUpdateBody *string `min:"1" type:"string"`
20522052
20532053 // Location of a file containing the temporary overriding stack policy. The
20542054 // URL must point to a policy (max size: 16KB) located in an S3 bucket in the
20582058 // If you want to update protected resources, specify a temporary overriding
20592059 // stack policy during this update. If you do not specify a stack policy, the
20602060 // current policy that is associated with the stack will be used.
2061 StackPolicyDuringUpdateURL *string `type:"string"`
2061 StackPolicyDuringUpdateURL *string `min:"1" type:"string"`
20622062
20632063 // Location of a file containing the updated stack policy. The URL must point
20642064 // to a policy (max size: 16KB) located in an S3 bucket in the same region as
20682068 // You might update the stack policy, for example, in order to protect a new
20692069 // resource that you created during a stack update. If you do not specify a
20702070 // stack policy, the current policy that is associated with the stack is unchanged.
2071 StackPolicyURL *string `type:"string"`
2071 StackPolicyURL *string `min:"1" type:"string"`
20722072
20732073 // Structure containing the template body with a minimum length of 1 byte and
20742074 // a maximum length of 51,200 bytes. (For more information, go to Template Anatomy
20772077 //
20782078 // Conditional: You must specify either the TemplateBody or the TemplateURL
20792079 // parameter, but not both.
2080 TemplateBody *string `type:"string"`
2080 TemplateBody *string `min:"1" type:"string"`
20812081
20822082 // Location of file containing the template body. The URL must point to a template
20832083 // located in an S3 bucket in the same region as the stack. For more information,
20862086 //
20872087 // Conditional: You must specify either the TemplateBody or the TemplateURL
20882088 // parameter, but not both.
2089 TemplateURL *string `type:"string"`
2089 TemplateURL *string `min:"1" type:"string"`
20902090
20912091 // Reuse the existing template that is associated with the stack that you are
20922092 // updating.
21402140 //
21412141 // Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
21422142 // only TemplateBody is used.
2143 TemplateBody *string `type:"string"`
2143 TemplateBody *string `min:"1" type:"string"`
21442144
21452145 // Location of file containing the template body. The URL must point to a template
21462146 // (max size: 460,800 bytes) located in an S3 bucket in the same region as the
21492149 //
21502150 // Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
21512151 // only TemplateBody is used.
2152 TemplateURL *string `type:"string"`
2152 TemplateURL *string `min:"1" type:"string"`
21532153
21542154 metadataValidateTemplateInput `json:"-" xml:"-"`
21552155 }
+1
-1
service/cloudfront/api.go less more
27912791 // A complex type that contains information about origins for this distribution.
27922792 type Origins struct {
27932793 // A complex type that contains origins for this distribution.
2794 Items []*Origin `locationNameList:"Origin" type:"list"`
2794 Items []*Origin `locationNameList:"Origin" min:"1" type:"list"`
27952795
27962796 // The number of origins for this distribution.
27972797 Quantity *int64 `type:"integer" required:"true"`
+3
-3
service/cloudhsm/api.go less more
627627 type CreateLunaClientInput struct {
628628 // The contents of a Base64-Encoded X.509 v3 certificate to be installed on
629629 // the HSMs used by this client.
630 Certificate *string `type:"string" required:"true"`
630 Certificate *string `min:"600" type:"string" required:"true"`
631631
632632 // The label for the client.
633633 Label *string `type:"string"`
10081008
10091009 type DescribeLunaClientOutput struct {
10101010 // The certificate installed on the HSMs used by this client.
1011 Certificate *string `type:"string"`
1011 Certificate *string `min:"600" type:"string"`
10121012
10131013 // The certificate fingerprint.
10141014 CertificateFingerprint *string `type:"string"`
13921392
13931393 type ModifyLunaClientInput struct {
13941394 // The new certificate for the client.
1395 Certificate *string `type:"string" required:"true"`
1395 Certificate *string `min:"600" type:"string" required:"true"`
13961396
13971397 // The ARN of the client.
13981398 ClientArn *string `type:"string" required:"true"`
+45
-45
service/cloudsearch/api.go less more
846846
847847 // Names must begin with a letter and can contain the following characters:
848848 // a-z (lowercase), 0-9, and _ (underscore).
849 AnalysisSchemeName *string `type:"string" required:"true"`
849 AnalysisSchemeName *string `min:"1" type:"string" required:"true"`
850850
851851 metadataAnalysisScheme `json:"-" xml:"-"`
852852 }
925925 // the domains owned by an account within an AWS region. Domain names start
926926 // with a letter or number and can contain the following characters: a-z (lowercase),
927927 // 0-9, and - (hyphen).
928 DomainName *string `type:"string" required:"true"`
928 DomainName *string `min:"3" type:"string" required:"true"`
929929
930930 metadataBuildSuggestersInput `json:"-" xml:"-"`
931931 }
973973 // A name for the domain you are creating. Allowed characters are a-z (lower-case
974974 // letters), 0-9, and hyphen (-). Domain names must start with a letter or number
975975 // and be at least 3 and no more than 28 characters long.
976 DomainName *string `type:"string" required:"true"`
976 DomainName *string `min:"3" type:"string" required:"true"`
977977
978978 metadataCreateDomainInput `json:"-" xml:"-"`
979979 }
10841084 //
10851085 // The name score is reserved and cannot be used as a field name. To reference
10861086 // a document's ID, you can use the name _id.
1087 SourceField *string `type:"string"`
1087 SourceField *string `min:"1" type:"string"`
10881088
10891089 metadataDateOptions `json:"-" xml:"-"`
10901090 }
11161116 // the domains owned by an account within an AWS region. Domain names start
11171117 // with a letter or number and can contain the following characters: a-z (lowercase),
11181118 // 0-9, and - (hyphen).
1119 DomainName *string `type:"string" required:"true"`
1119 DomainName *string `min:"3" type:"string" required:"true"`
11201120
11211121 metadataDefineAnalysisSchemeInput `json:"-" xml:"-"`
11221122 }
11661166 // the domains owned by an account within an AWS region. Domain names start
11671167 // with a letter or number and can contain the following characters: a-z (lowercase),
11681168 // 0-9, and - (hyphen).
1169 DomainName *string `type:"string" required:"true"`
1169 DomainName *string `min:"3" type:"string" required:"true"`
11701170
11711171 // A named expression that can be evaluated at search time. Can be used to sort
11721172 // the search results, define other expressions, or return computed information
12201220 // the domains owned by an account within an AWS region. Domain names start
12211221 // with a letter or number and can contain the following characters: a-z (lowercase),
12221222 // 0-9, and - (hyphen).
1223 DomainName *string `type:"string" required:"true"`
1223 DomainName *string `min:"3" type:"string" required:"true"`
12241224
12251225 // The index field and field options you want to configure.
12261226 IndexField *IndexField `type:"structure" required:"true"`
12721272 // the domains owned by an account within an AWS region. Domain names start
12731273 // with a letter or number and can contain the following characters: a-z (lowercase),
12741274 // 0-9, and - (hyphen).
1275 DomainName *string `type:"string" required:"true"`
1275 DomainName *string `min:"3" type:"string" required:"true"`
12761276
12771277 // Configuration information for a search suggester. Each suggester has a unique
12781278 // name and specifies the text field you want to use for suggestions. The following
13241324 // to delete.
13251325 type DeleteAnalysisSchemeInput struct {
13261326 // The name of the analysis scheme you want to delete.
1327 AnalysisSchemeName *string `type:"string" required:"true"`
1327 AnalysisSchemeName *string `min:"1" type:"string" required:"true"`
13281328
13291329 // A string that represents the name of a domain. Domain names are unique across
13301330 // the domains owned by an account within an AWS region. Domain names start
13311331 // with a letter or number and can contain the following characters: a-z (lowercase),
13321332 // 0-9, and - (hyphen).
1333 DomainName *string `type:"string" required:"true"`
1333 DomainName *string `min:"3" type:"string" required:"true"`
13341334
13351335 metadataDeleteAnalysisSchemeInput `json:"-" xml:"-"`
13361336 }
13761376 // name of the domain you want to delete.
13771377 type DeleteDomainInput struct {
13781378 // The name of the domain you want to permanently delete.
1379 DomainName *string `type:"string" required:"true"`
1379 DomainName *string `min:"3" type:"string" required:"true"`
13801380
13811381 metadataDeleteDomainInput `json:"-" xml:"-"`
13821382 }
14261426 // the domains owned by an account within an AWS region. Domain names start
14271427 // with a letter or number and can contain the following characters: a-z (lowercase),
14281428 // 0-9, and - (hyphen).
1429 DomainName *string `type:"string" required:"true"`
1429 DomainName *string `min:"3" type:"string" required:"true"`
14301430
14311431 // The name of the Expression to delete.
1432 ExpressionName *string `type:"string" required:"true"`
1432 ExpressionName *string `min:"1" type:"string" required:"true"`
14331433
14341434 metadataDeleteExpressionInput `json:"-" xml:"-"`
14351435 }
14791479 // the domains owned by an account within an AWS region. Domain names start
14801480 // with a letter or number and can contain the following characters: a-z (lowercase),
14811481 // 0-9, and - (hyphen).
1482 DomainName *string `type:"string" required:"true"`
1482 DomainName *string `min:"3" type:"string" required:"true"`
14831483
14841484 // The name of the index field your want to remove from the domain's indexing
14851485 // options.
1486 IndexFieldName *string `type:"string" required:"true"`
1486 IndexFieldName *string `min:"1" type:"string" required:"true"`
14871487
14881488 metadataDeleteIndexFieldInput `json:"-" xml:"-"`
14891489 }
15321532 // the domains owned by an account within an AWS region. Domain names start
15331533 // with a letter or number and can contain the following characters: a-z (lowercase),
15341534 // 0-9, and - (hyphen).
1535 DomainName *string `type:"string" required:"true"`
1535 DomainName *string `min:"3" type:"string" required:"true"`
15361536
15371537 // Specifies the name of the suggester you want to delete.
1538 SuggesterName *string `type:"string" required:"true"`
1538 SuggesterName *string `min:"1" type:"string" required:"true"`
15391539
15401540 metadataDeleteSuggesterInput `json:"-" xml:"-"`
15411541 }
15911591 Deployed *bool `type:"boolean"`
15921592
15931593 // The name of the domain you want to describe.
1594 DomainName *string `type:"string" required:"true"`
1594 DomainName *string `min:"3" type:"string" required:"true"`
15951595
15961596 metadataDescribeAnalysisSchemesInput `json:"-" xml:"-"`
15971597 }
16431643 Deployed *bool `type:"boolean"`
16441644
16451645 // The name of the domain you want to describe.
1646 DomainName *string `type:"string" required:"true"`
1646 DomainName *string `min:"3" type:"string" required:"true"`
16471647
16481648 metadataDescribeAvailabilityOptionsInput `json:"-" xml:"-"`
16491649 }
17441744 Deployed *bool `type:"boolean"`
17451745
17461746 // The name of the domain you want to describe.
1747 DomainName *string `type:"string" required:"true"`
1747 DomainName *string `min:"3" type:"string" required:"true"`
17481748
17491749 // Limits the DescribeExpressions response to the specified expressions. If
17501750 // not specified, all expressions are shown.
18011801 Deployed *bool `type:"boolean"`
18021802
18031803 // The name of the domain you want to describe.
1804 DomainName *string `type:"string" required:"true"`
1804 DomainName *string `min:"3" type:"string" required:"true"`
18051805
18061806 // A list of the index fields you want to describe. If not specified, information
18071807 // is returned for all configured index fields.
18541854 // the domains owned by an account within an AWS region. Domain names start
18551855 // with a letter or number and can contain the following characters: a-z (lowercase),
18561856 // 0-9, and - (hyphen).
1857 DomainName *string `type:"string" required:"true"`
1857 DomainName *string `min:"3" type:"string" required:"true"`
18581858
18591859 metadataDescribeScalingParametersInput `json:"-" xml:"-"`
18601860 }
19061906 Deployed *bool `type:"boolean"`
19071907
19081908 // The name of the domain you want to describe.
1909 DomainName *string `type:"string" required:"true"`
1909 DomainName *string `min:"3" type:"string" required:"true"`
19101910
19111911 metadataDescribeServiceAccessPoliciesInput `json:"-" xml:"-"`
19121912 }
19581958 Deployed *bool `type:"boolean"`
19591959
19601960 // The name of the domain you want to describe.
1961 DomainName *string `type:"string" required:"true"`
1961 DomainName *string `min:"3" type:"string" required:"true"`
19621962
19631963 // The suggesters you want to describe.
19641964 SuggesterNames []*string `type:"list"`
20212021 SortExpression *string `type:"string"`
20222022
20232023 // The name of the index field you want to use for suggestions.
2024 SourceField *string `type:"string" required:"true"`
2024 SourceField *string `min:"1" type:"string" required:"true"`
20252025
20262026 metadataDocumentSuggesterOptions `json:"-" xml:"-"`
20272027 }
20632063 DocService *ServiceEndpoint `type:"structure"`
20642064
20652065 // An internally generated unique identifier for a domain.
2066 DomainId *string `type:"string" required:"true"`
2066 DomainId *string `min:"1" type:"string" required:"true"`
20672067
20682068 // A string that represents the name of a domain. Domain names are unique across
20692069 // the domains owned by an account within an AWS region. Domain names start
20702070 // with a letter or number and can contain the following characters: a-z (lowercase),
20712071 // 0-9, and - (hyphen).
2072 DomainName *string `type:"string" required:"true"`
2072 DomainName *string `min:"3" type:"string" required:"true"`
20732073
20742074 Limits *Limits `type:"structure"`
20752075
20812081 RequiresIndexDocuments *bool `type:"boolean" required:"true"`
20822082
20832083 // The number of search instances that are available to process search requests.
2084 SearchInstanceCount *int64 `type:"integer"`
2084 SearchInstanceCount *int64 `min:"1" type:"integer"`
20852085
20862086 // The instance type that is being used to process search requests.
20872087 SearchInstanceType *string `type:"string"`
20882088
20892089 // The number of partitions across which the search index is spread.
2090 SearchPartitionCount *int64 `type:"integer"`
2090 SearchPartitionCount *int64 `min:"1" type:"integer"`
20912091
20922092 // The service endpoint for requesting search results from a search domain.
20932093 SearchService *ServiceEndpoint `type:"structure"`
21662166 SortEnabled *bool `type:"boolean"`
21672167
21682168 // The name of the source field to map to the field.
2169 SourceField *string `type:"string"`
2169 SourceField *string `min:"1" type:"string"`
21702170
21712171 metadataDoubleOptions `json:"-" xml:"-"`
21722172 }
21912191 type Expression struct {
21922192 // Names must begin with a letter and can contain the following characters:
21932193 // a-z (lowercase), 0-9, and _ (underscore).
2194 ExpressionName *string `type:"string" required:"true"`
2194 ExpressionName *string `min:"1" type:"string" required:"true"`
21952195
21962196 // The expression to evaluate for sorting while processing a search request.
21972197 // The Expression syntax is based on JavaScript expressions. For more information,
21982198 // see Configuring Expressions (http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html"
21992199 // target="_blank) in the Amazon CloudSearch Developer Guide.
2200 ExpressionValue *string `type:"string" required:"true"`
2200 ExpressionValue *string `min:"1" type:"string" required:"true"`
22012201
22022202 metadataExpression `json:"-" xml:"-"`
22032203 }
22482248 // the domains owned by an account within an AWS region. Domain names start
22492249 // with a letter or number and can contain the following characters: a-z (lowercase),
22502250 // 0-9, and - (hyphen).
2251 DomainName *string `type:"string" required:"true"`
2251 DomainName *string `min:"3" type:"string" required:"true"`
22522252
22532253 metadataIndexDocumentsInput `json:"-" xml:"-"`
22542254 }
23262326 //
23272327 // The name score is reserved and cannot be used as a field name. To reference
23282328 // a document's ID, you can use the name _id.
2329 IndexFieldName *string `type:"string" required:"true"`
2329 IndexFieldName *string `min:"1" type:"string" required:"true"`
23302330
23312331 // The type of field. The valid options for a field depend on the field type.
23322332 // For more information about the supported field types, see Configuring Index
24672467 SortEnabled *bool `type:"boolean"`
24682468
24692469 // The name of the source field to map to the field.
2470 SourceField *string `type:"string"`
2470 SourceField *string `min:"1" type:"string"`
24712471
24722472 metadataIntOptions `json:"-" xml:"-"`
24732473 }
25192519 //
25202520 // The name score is reserved and cannot be used as a field name. To reference
25212521 // a document's ID, you can use the name _id.
2522 SourceField *string `type:"string"`
2522 SourceField *string `min:"1" type:"string"`
25232523
25242524 metadataLatLonOptions `json:"-" xml:"-"`
25252525 }
25392539 }
25402540
25412541 type Limits struct {
2542 MaximumPartitionCount *int64 `type:"integer" required:"true"`
2543
2544 MaximumReplicationCount *int64 `type:"integer" required:"true"`
2542 MaximumPartitionCount *int64 `min:"1" type:"integer" required:"true"`
2543
2544 MaximumReplicationCount *int64 `min:"1" type:"integer" required:"true"`
25452545
25462546 metadataLimits `json:"-" xml:"-"`
25472547 }
26692669 //
26702670 // The name score is reserved and cannot be used as a field name. To reference
26712671 // a document's ID, you can use the name _id.
2672 SourceField *string `type:"string"`
2672 SourceField *string `min:"1" type:"string"`
26732673
26742674 metadataLiteralOptions `json:"-" xml:"-"`
26752675 }
28172817
28182818 // Names must begin with a letter and can contain the following characters:
28192819 // a-z (lowercase), 0-9, and _ (underscore).
2820 SuggesterName *string `type:"string" required:"true"`
2820 SuggesterName *string `min:"1" type:"string" required:"true"`
28212821
28222822 metadataSuggester `json:"-" xml:"-"`
28232823 }
29322932 //
29332933 // The name score is reserved and cannot be used as a field name. To reference
29342934 // a document's ID, you can use the name _id.
2935 SourceField *string `type:"string"`
2935 SourceField *string `min:"1" type:"string"`
29362936
29372937 metadataTextOptions `json:"-" xml:"-"`
29382938 }
29592959 // the domains owned by an account within an AWS region. Domain names start
29602960 // with a letter or number and can contain the following characters: a-z (lowercase),
29612961 // 0-9, and - (hyphen).
2962 DomainName *string `type:"string" required:"true"`
2962 DomainName *string `min:"3" type:"string" required:"true"`
29632963
29642964 // You expand an existing search domain to a second Availability Zone by setting
29652965 // the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option
30163016 // the domains owned by an account within an AWS region. Domain names start
30173017 // with a letter or number and can contain the following characters: a-z (lowercase),
30183018 // 0-9, and - (hyphen).
3019 DomainName *string `type:"string" required:"true"`
3019 DomainName *string `min:"3" type:"string" required:"true"`
30203020
30213021 // The desired instance type and desired number of replicas of each index partition.
30223022 ScalingParameters *ScalingParameters `type:"structure" required:"true"`
30733073 // the domains owned by an account within an AWS region. Domain names start
30743074 // with a letter or number and can contain the following characters: a-z (lowercase),
30753075 // 0-9, and - (hyphen).
3076 DomainName *string `type:"string" required:"true"`
3076 DomainName *string `min:"3" type:"string" required:"true"`
30773077
30783078 metadataUpdateServiceAccessPoliciesInput `json:"-" xml:"-"`
30793079 }
+1
-1
service/cloudtrail/api.go less more
590590
591591 // The number of events to return. Possible values are 1 through 50. The default
592592 // is 10.
593 MaxResults *int64 `type:"integer"`
593 MaxResults *int64 `min:"1" type:"integer"`
594594
595595 // The token to use to get the next page of results after a previous API call.
596596 // This token must be passed in with the same parameters that were specified
+37
-37
service/cloudwatch/api.go less more
405405 // returns this data type as part of the DescribeAlarmHistoryResult data type.
406406 type AlarmHistoryItem struct {
407407 // The descriptive name for the alarm.
408 AlarmName *string `type:"string"`
408 AlarmName *string `min:"1" type:"string"`
409409
410410 // Machine-readable data about the alarm in JSON format.
411 HistoryData *string `type:"string"`
411 HistoryData *string `min:"1" type:"string"`
412412
413413 // The type of alarm history item.
414414 HistoryItemType *string `type:"string" enum:"HistoryItemType"`
415415
416416 // A human-readable summary of the alarm history.
417 HistorySummary *string `type:"string"`
417 HistorySummary *string `min:"1" type:"string"`
418418
419419 // The time stamp for the alarm history item. Amazon CloudWatch uses Coordinated
420420 // Universal Time (UTC) when returning time stamps, which do not accommodate
527527
528528 type DescribeAlarmHistoryInput struct {
529529 // The name of the alarm.
530 AlarmName *string `type:"string"`
530 AlarmName *string `min:"1" type:"string"`
531531
532532 // The ending date to retrieve alarm history.
533533 EndDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
536536 HistoryItemType *string `type:"string" enum:"HistoryItemType"`
537537
538538 // The maximum number of alarm history records to retrieve.
539 MaxRecords *int64 `type:"integer"`
539 MaxRecords *int64 `min:"1" type:"integer"`
540540
541541 // The token returned by a previous call to indicate that there is more data
542542 // available.
592592 Dimensions []*Dimension `type:"list"`
593593
594594 // The name of the metric.
595 MetricName *string `type:"string" required:"true"`
595 MetricName *string `min:"1" type:"string" required:"true"`
596596
597597 // The namespace of the metric.
598 Namespace *string `type:"string" required:"true"`
598 Namespace *string `min:"1" type:"string" required:"true"`
599599
600600 // The period in seconds over which the statistic is applied.
601 Period *int64 `type:"integer"`
601 Period *int64 `min:"60" type:"integer"`
602602
603603 // The statistic for the metric.
604604 Statistic *string `type:"string" enum:"Statistic"`
647647
648648 type DescribeAlarmsInput struct {
649649 // The action name prefix.
650 ActionPrefix *string `type:"string"`
650 ActionPrefix *string `min:"1" type:"string"`
651651
652652 // The alarm name prefix. AlarmNames cannot be specified if this parameter is
653653 // specified.
654 AlarmNamePrefix *string `type:"string"`
654 AlarmNamePrefix *string `min:"1" type:"string"`
655655
656656 // A list of alarm names to retrieve information for.
657657 AlarmNames []*string `type:"list"`
658658
659659 // The maximum number of alarm descriptions to retrieve.
660 MaxRecords *int64 `type:"integer"`
660 MaxRecords *int64 `min:"1" type:"integer"`
661661
662662 // The token returned by a previous call to indicate that there is more data
663663 // available.
714714 // For examples that use one or more dimensions, see PutMetricData.
715715 type Dimension struct {
716716 // The name of the dimension.
717 Name *string `type:"string" required:"true"`
717 Name *string `min:"1" type:"string" required:"true"`
718718
719719 // The value representing the dimension measurement
720 Value *string `type:"string" required:"true"`
720 Value *string `min:"1" type:"string" required:"true"`
721721
722722 metadataDimension `json:"-" xml:"-"`
723723 }
739739 // The DimensionFilter data type is used to filter ListMetrics results.
740740 type DimensionFilter struct {
741741 // The dimension name to be matched.
742 Name *string `type:"string" required:"true"`
742 Name *string `min:"1" type:"string" required:"true"`
743743
744744 // The value of the dimension to be matched.
745 Value *string `type:"string"`
745 Value *string `min:"1" type:"string"`
746746
747747 metadataDimensionFilter `json:"-" xml:"-"`
748748 }
849849 EndTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
850850
851851 // The name of the metric, with or without spaces.
852 MetricName *string `type:"string" required:"true"`
852 MetricName *string `min:"1" type:"string" required:"true"`
853853
854854 // The namespace of the metric, with or without spaces.
855 Namespace *string `type:"string" required:"true"`
855 Namespace *string `min:"1" type:"string" required:"true"`
856856
857857 // The granularity, in seconds, of the returned datapoints. Period must be at
858858 // least 60 seconds and must be a multiple of 60. The default value is 60.
859 Period *int64 `type:"integer" required:"true"`
859 Period *int64 `min:"60" type:"integer" required:"true"`
860860
861861 // The time stamp to use for determining the first datapoint to return. The
862862 // value specified is inclusive; results include datapoints with the time stamp
868868 // in the Amazon CloudWatch Developer Guide.
869869 //
870870 // Valid Values: Average | Sum | SampleCount | Maximum | Minimum
871 Statistics []*string `type:"list" required:"true"`
871 Statistics []*string `min:"1" type:"list" required:"true"`
872872
873873 // The unit for the metric.
874874 Unit *string `type:"string" enum:"StandardUnit"`
920920 Dimensions []*DimensionFilter `type:"list"`
921921
922922 // The name of the metric to filter against.
923 MetricName *string `type:"string"`
923 MetricName *string `min:"1" type:"string"`
924924
925925 // The namespace to filter against.
926 Namespace *string `type:"string"`
926 Namespace *string `min:"1" type:"string"`
927927
928928 // The token returned by a previous call to indicate that there is more data
929929 // available.
983983 Dimensions []*Dimension `type:"list"`
984984
985985 // The name of the metric.
986 MetricName *string `type:"string"`
986 MetricName *string `min:"1" type:"string"`
987987
988988 // The namespace of the metric.
989 Namespace *string `type:"string"`
989 Namespace *string `min:"1" type:"string"`
990990
991991 metadataMetric `json:"-" xml:"-"`
992992 }
10191019 AlarmActions []*string `type:"list"`
10201020
10211021 // The Amazon Resource Name (ARN) of the alarm.
1022 AlarmArn *string `type:"string"`
1022 AlarmArn *string `min:"1" type:"string"`
10231023
10241024 // The time stamp of the last update to the alarm configuration. Amazon CloudWatch
10251025 // uses Coordinated Universal Time (UTC) when returning time stamps, which do
10321032 AlarmDescription *string `type:"string"`
10331033
10341034 // The name of the alarm.
1035 AlarmName *string `type:"string"`
1035 AlarmName *string `min:"1" type:"string"`
10361036
10371037 // The arithmetic operation to use when comparing the specified Statistic and
10381038 // Threshold. The specified Statistic value is used as the first operand.
10421042 Dimensions []*Dimension `type:"list"`
10431043
10441044 // The number of periods over which data is compared to the specified threshold.
1045 EvaluationPeriods *int64 `type:"integer"`
1045 EvaluationPeriods *int64 `min:"1" type:"integer"`
10461046
10471047 // The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
10481048 // state from any other state. Each action is specified as an Amazon Resource
10531053 InsufficientDataActions []*string `type:"list"`
10541054
10551055 // The name of the alarm's metric.
1056 MetricName *string `type:"string"`
1056 MetricName *string `min:"1" type:"string"`
10571057
10581058 // The namespace of alarm's associated metric.
1059 Namespace *string `type:"string"`
1059 Namespace *string `min:"1" type:"string"`
10601060
10611061 // The list of actions to execute when this alarm transitions into an OK state
10621062 // from any other state. Each action is specified as an Amazon Resource Number
10651065 OKActions []*string `type:"list"`
10661066
10671067 // The period in seconds over which the statistic is applied.
1068 Period *int64 `type:"integer"`
1068 Period *int64 `min:"60" type:"integer"`
10691069
10701070 // A human-readable explanation for the alarm's state.
10711071 StateReason *string `type:"string"`
11181118 Dimensions []*Dimension `type:"list"`
11191119
11201120 // The name of the metric.
1121 MetricName *string `type:"string" required:"true"`
1121 MetricName *string `min:"1" type:"string" required:"true"`
11221122
11231123 // A set of statistical values describing the metric.
11241124 StatisticValues *StatisticSet `type:"structure"`
11751175
11761176 // The descriptive name for the alarm. This name must be unique within the user's
11771177 // AWS account
1178 AlarmName *string `type:"string" required:"true"`
1178 AlarmName *string `min:"1" type:"string" required:"true"`
11791179
11801180 // The arithmetic operation to use when comparing the specified Statistic and
11811181 // Threshold. The specified Statistic value is used as the first operand.
11851185 Dimensions []*Dimension `type:"list"`
11861186
11871187 // The number of periods over which data is compared to the specified threshold.
1188 EvaluationPeriods *int64 `type:"integer" required:"true"`
1188 EvaluationPeriods *int64 `min:"1" type:"integer" required:"true"`
11891189
11901190 // The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
11911191 // state from any other state. Each action is specified as an Amazon Resource
11941194 InsufficientDataActions []*string `type:"list"`
11951195
11961196 // The name for the alarm's associated metric.
1197 MetricName *string `type:"string" required:"true"`
1197 MetricName *string `min:"1" type:"string" required:"true"`
11981198
11991199 // The namespace for the alarm's associated metric.
1200 Namespace *string `type:"string" required:"true"`
1200 Namespace *string `min:"1" type:"string" required:"true"`
12011201
12021202 // The list of actions to execute when this alarm transitions into an OK state
12031203 // from any other state. Each action is specified as an Amazon Resource Number
12061206 OKActions []*string `type:"list"`
12071207
12081208 // The period in seconds over which the specified statistic is applied.
1209 Period *int64 `type:"integer" required:"true"`
1209 Period *int64 `min:"60" type:"integer" required:"true"`
12101210
12111211 // The statistic to apply to the alarm's associated metric.
12121212 Statistic *string `type:"string" required:"true" enum:"Statistic"`
12571257 MetricData []*MetricDatum `type:"list" required:"true"`
12581258
12591259 // The namespace for the metric data.
1260 Namespace *string `type:"string" required:"true"`
1260 Namespace *string `min:"1" type:"string" required:"true"`
12611261
12621262 metadataPutMetricDataInput `json:"-" xml:"-"`
12631263 }
12971297 type SetAlarmStateInput struct {
12981298 // The descriptive name for the alarm. This name must be unique within the user's
12991299 // AWS account. The maximum length is 255 characters.
1300 AlarmName *string `type:"string" required:"true"`
1300 AlarmName *string `min:"1" type:"string" required:"true"`
13011301
13021302 // The reason that this alarm is set to this specific state (in human-readable
13031303 // text format)
+469
-89
service/cloudwatchlogs/api.go less more
66 "github.com/aws/aws-sdk-go/aws/awsutil"
77 "github.com/aws/aws-sdk-go/aws/request"
88 )
9
10 const opCancelExportTask = "CancelExportTask"
11
12 // CancelExportTaskRequest generates a request for the CancelExportTask operation.
13 func (c *CloudWatchLogs) CancelExportTaskRequest(input *CancelExportTaskInput) (req *request.Request, output *CancelExportTaskOutput) {
14 op := &request.Operation{
15 Name: opCancelExportTask,
16 HTTPMethod: "POST",
17 HTTPPath: "/",
18 }
19
20 if input == nil {
21 input = &CancelExportTaskInput{}
22 }
23
24 req = c.newRequest(op, input, output)
25 output = &CancelExportTaskOutput{}
26 req.Data = output
27 return
28 }
29
30 // Cancels an export task if it is in PENDING or RUNNING state.
31 func (c *CloudWatchLogs) CancelExportTask(input *CancelExportTaskInput) (*CancelExportTaskOutput, error) {
32 req, out := c.CancelExportTaskRequest(input)
33 err := req.Send()
34 return out, err
35 }
36
37 const opCreateExportTask = "CreateExportTask"
38
39 // CreateExportTaskRequest generates a request for the CreateExportTask operation.
40 func (c *CloudWatchLogs) CreateExportTaskRequest(input *CreateExportTaskInput) (req *request.Request, output *CreateExportTaskOutput) {
41 op := &request.Operation{
42 Name: opCreateExportTask,
43 HTTPMethod: "POST",
44 HTTPPath: "/",
45 }
46
47 if input == nil {
48 input = &CreateExportTaskInput{}
49 }
50
51 req = c.newRequest(op, input, output)
52 output = &CreateExportTaskOutput{}
53 req.Data = output
54 return
55 }
56
57 // Creates an ExportTask which allows you to efficiently export data from a
58 // Log Group to your Amazon S3 bucket.
59 //
60 // This is an asynchronous call. If all the required information is provided,
61 // this API will initiate an export task and respond with the task Id. Once
62 // started, DescribeExportTasks can be used to get the status of an export task.
63 func (c *CloudWatchLogs) CreateExportTask(input *CreateExportTaskInput) (*CreateExportTaskOutput, error) {
64 req, out := c.CreateExportTaskRequest(input)
65 err := req.Send()
66 return out, err
67 }
968
1069 const opCreateLogGroup = "CreateLogGroup"
1170
285344 return page.EachPage(func(p interface{}, lastPage bool) bool {
286345 return fn(p.(*DescribeDestinationsOutput), lastPage)
287346 })
347 }
348
349 const opDescribeExportTasks = "DescribeExportTasks"
350
351 // DescribeExportTasksRequest generates a request for the DescribeExportTasks operation.
352 func (c *CloudWatchLogs) DescribeExportTasksRequest(input *DescribeExportTasksInput) (req *request.Request, output *DescribeExportTasksOutput) {
353 op := &request.Operation{
354 Name: opDescribeExportTasks,
355 HTTPMethod: "POST",
356 HTTPPath: "/",
357 }
358
359 if input == nil {
360 input = &DescribeExportTasksInput{}
361 }
362
363 req = c.newRequest(op, input, output)
364 output = &DescribeExportTasksOutput{}
365 req.Data = output
366 return
367 }
368
369 // Returns all the export tasks that are associated with the AWS account making
370 // the request. The export tasks can be filtered based on TaskId or TaskStatus.
371 //
372 // By default, this operation returns up to 50 export tasks that satisfy the
373 // specified filters. If there are more export tasks to list, the response would
374 // contain a nextToken value in the response body. You can also limit the number
375 // of export tasks returned in the response by specifying the limit parameter
376 // in the request.
377 func (c *CloudWatchLogs) DescribeExportTasks(input *DescribeExportTasksInput) (*DescribeExportTasksOutput, error) {
378 req, out := c.DescribeExportTasksRequest(input)
379 err := req.Send()
380 return out, err
288381 }
289382
290383 const opDescribeLogGroups = "DescribeLogGroups"
809902 return out, err
810903 }
811904
905 type CancelExportTaskInput struct {
906 // Id of the export task to cancel.
907 TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
908
909 metadataCancelExportTaskInput `json:"-" xml:"-"`
910 }
911
912 type metadataCancelExportTaskInput struct {
913 SDKShapeTraits bool `type:"structure"`
914 }
915
916 // String returns the string representation
917 func (s CancelExportTaskInput) String() string {
918 return awsutil.Prettify(s)
919 }
920
921 // GoString returns the string representation
922 func (s CancelExportTaskInput) GoString() string {
923 return s.String()
924 }
925
926 type CancelExportTaskOutput struct {
927 metadataCancelExportTaskOutput `json:"-" xml:"-"`
928 }
929
930 type metadataCancelExportTaskOutput struct {
931 SDKShapeTraits bool `type:"structure"`
932 }
933
934 // String returns the string representation
935 func (s CancelExportTaskOutput) String() string {
936 return awsutil.Prettify(s)
937 }
938
939 // GoString returns the string representation
940 func (s CancelExportTaskOutput) GoString() string {
941 return s.String()
942 }
943
944 type CreateExportTaskInput struct {
945 // Name of Amazon S3 bucket to which the log data will be exported. NOTE: Only
946 // buckets in the same AWS region are supported
947 Destination *string `locationName:"destination" min:"1" type:"string" required:"true"`
948
949 // Prefix that will be used as the start of Amazon S3 key for every object exported.
950 // If not specified, this defaults to 'exportedlogs'.
951 DestinationPrefix *string `locationName:"destinationPrefix" type:"string"`
952
953 // A unix timestamp indicating the start time of the range for the request.
954 // Events with a timestamp prior to this time will not be exported.
955 From *int64 `locationName:"from" type:"long" required:"true"`
956
957 // The name of the log group to export.
958 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
959
960 // Will only export log streams that match the provided logStreamNamePrefix.
961 // If you don't specify a value, no prefix filter is applied.
962 LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"`
963
964 // The name of the export task.
965 TaskName *string `locationName:"taskName" min:"1" type:"string"`
966
967 // A unix timestamp indicating the end time of the range for the request. Events
968 // with a timestamp later than this time will not be exported.
969 To *int64 `locationName:"to" type:"long" required:"true"`
970
971 metadataCreateExportTaskInput `json:"-" xml:"-"`
972 }
973
974 type metadataCreateExportTaskInput struct {
975 SDKShapeTraits bool `type:"structure"`
976 }
977
978 // String returns the string representation
979 func (s CreateExportTaskInput) String() string {
980 return awsutil.Prettify(s)
981 }
982
983 // GoString returns the string representation
984 func (s CreateExportTaskInput) GoString() string {
985 return s.String()
986 }
987
988 type CreateExportTaskOutput struct {
989 // Id of the export task that got created.
990 TaskId *string `locationName:"taskId" min:"1" type:"string"`
991
992 metadataCreateExportTaskOutput `json:"-" xml:"-"`
993 }
994
995 type metadataCreateExportTaskOutput struct {
996 SDKShapeTraits bool `type:"structure"`
997 }
998
999 // String returns the string representation
1000 func (s CreateExportTaskOutput) String() string {
1001 return awsutil.Prettify(s)
1002 }
1003
1004 // GoString returns the string representation
1005 func (s CreateExportTaskOutput) GoString() string {
1006 return s.String()
1007 }
1008
8121009 type CreateLogGroupInput struct {
8131010 // The name of the log group to create.
814 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1011 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
8151012
8161013 metadataCreateLogGroupInput `json:"-" xml:"-"`
8171014 }
8501047
8511048 type CreateLogStreamInput struct {
8521049 // The name of the log group under which the log stream is to be created.
853 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1050 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
8541051
8551052 // The name of the log stream to create.
856 LogStreamName *string `locationName:"logStreamName" type:"string" required:"true"`
1053 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
8571054
8581055 metadataCreateLogStreamInput `json:"-" xml:"-"`
8591056 }
8921089
8931090 type DeleteDestinationInput struct {
8941091 // The name of destination to delete.
895 DestinationName *string `locationName:"destinationName" type:"string" required:"true"`
1092 DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`
8961093
8971094 metadataDeleteDestinationInput `json:"-" xml:"-"`
8981095 }
9311128
9321129 type DeleteLogGroupInput struct {
9331130 // The name of the log group to delete.
934 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1131 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
9351132
9361133 metadataDeleteLogGroupInput `json:"-" xml:"-"`
9371134 }
9701167
9711168 type DeleteLogStreamInput struct {
9721169 // The name of the log group under which the log stream to delete belongs.
973 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1170 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
9741171
9751172 // The name of the log stream to delete.
976 LogStreamName *string `locationName:"logStreamName" type:"string" required:"true"`
1173 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
9771174
9781175 metadataDeleteLogStreamInput `json:"-" xml:"-"`
9791176 }
10121209
10131210 type DeleteMetricFilterInput struct {
10141211 // The name of the metric filter to delete.
1015 FilterName *string `locationName:"filterName" type:"string" required:"true"`
1212 FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`
10161213
10171214 // The name of the log group that is associated with the metric filter to delete.
1018 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1215 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
10191216
10201217 metadataDeleteMetricFilterInput `json:"-" xml:"-"`
10211218 }
10551252 type DeleteRetentionPolicyInput struct {
10561253 // The name of the log group that is associated with the retention policy to
10571254 // delete.
1058 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1255 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
10591256
10601257 metadataDeleteRetentionPolicyInput `json:"-" xml:"-"`
10611258 }
10941291
10951292 type DeleteSubscriptionFilterInput struct {
10961293 // The name of the subscription filter to delete.
1097 FilterName *string `locationName:"filterName" type:"string" required:"true"`
1294 FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`
10981295
10991296 // The name of the log group that is associated with the subscription filter
11001297 // to delete.
1101 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1298 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
11021299
11031300 metadataDeleteSubscriptionFilterInput `json:"-" xml:"-"`
11041301 }
11381335 type DescribeDestinationsInput struct {
11391336 // Will only return destinations that match the provided destinationNamePrefix.
11401337 // If you don't specify a value, no prefix is applied.
1141 DestinationNamePrefix *string `type:"string"`
1338 DestinationNamePrefix *string `min:"1" type:"string"`
11421339
11431340 // The maximum number of results to return.
1144 Limit *int64 `locationName:"limit" type:"integer"`
1341 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
11451342
11461343 // A string token used for pagination that points to the next page of results.
11471344 // It must be a value obtained from the response of the previous request. The
11481345 // token expires after 24 hours.
1149 NextToken *string `locationName:"nextToken" type:"string"`
1346 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
11501347
11511348 metadataDescribeDestinationsInput `json:"-" xml:"-"`
11521349 }
11711368 // A string token used for pagination that points to the next page of results.
11721369 // It must be a value obtained from the response of the previous request. The
11731370 // token expires after 24 hours.
1174 NextToken *string `locationName:"nextToken" type:"string"`
1371 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
11751372
11761373 metadataDescribeDestinationsOutput `json:"-" xml:"-"`
11771374 }
11871384
11881385 // GoString returns the string representation
11891386 func (s DescribeDestinationsOutput) GoString() string {
1387 return s.String()
1388 }
1389
1390 type DescribeExportTasksInput struct {
1391 // The maximum number of items returned in the response. If you don't specify
1392 // a value, the request would return up to 50 items.
1393 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
1394
1395 // A string token used for pagination that points to the next page of results.
1396 // It must be a value obtained from the response of the previous DescribeExportTasks
1397 // request.
1398 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
1399
1400 // All export tasks that matches the specified status code will be returned.
1401 // This can return zero or more export tasks.
1402 StatusCode *string `locationName:"statusCode" type:"string" enum:"ExportTaskStatusCode"`
1403
1404 // Export task that matches the specified task Id will be returned. This can
1405 // result in zero or one export task.
1406 TaskId *string `locationName:"taskId" min:"1" type:"string"`
1407
1408 metadataDescribeExportTasksInput `json:"-" xml:"-"`
1409 }
1410
1411 type metadataDescribeExportTasksInput struct {
1412 SDKShapeTraits bool `type:"structure"`
1413 }
1414
1415 // String returns the string representation
1416 func (s DescribeExportTasksInput) String() string {
1417 return awsutil.Prettify(s)
1418 }
1419
1420 // GoString returns the string representation
1421 func (s DescribeExportTasksInput) GoString() string {
1422 return s.String()
1423 }
1424
1425 type DescribeExportTasksOutput struct {
1426 // A list of export tasks.
1427 ExportTasks []*ExportTask `locationName:"exportTasks" type:"list"`
1428
1429 // A string token used for pagination that points to the next page of results.
1430 // It must be a value obtained from the response of the previous request. The
1431 // token expires after 24 hours.
1432 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
1433
1434 metadataDescribeExportTasksOutput `json:"-" xml:"-"`
1435 }
1436
1437 type metadataDescribeExportTasksOutput struct {
1438 SDKShapeTraits bool `type:"structure"`
1439 }
1440
1441 // String returns the string representation
1442 func (s DescribeExportTasksOutput) String() string {
1443 return awsutil.Prettify(s)
1444 }
1445
1446 // GoString returns the string representation
1447 func (s DescribeExportTasksOutput) GoString() string {
11901448 return s.String()
11911449 }
11921450
11931451 type DescribeLogGroupsInput struct {
11941452 // The maximum number of items returned in the response. If you don't specify
11951453 // a value, the request would return up to 50 items.
1196 Limit *int64 `locationName:"limit" type:"integer"`
1454 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
11971455
11981456 // Will only return log groups that match the provided logGroupNamePrefix. If
11991457 // you don't specify a value, no prefix filter is applied.
1200 LogGroupNamePrefix *string `locationName:"logGroupNamePrefix" type:"string"`
1458 LogGroupNamePrefix *string `locationName:"logGroupNamePrefix" min:"1" type:"string"`
12011459
12021460 // A string token used for pagination that points to the next page of results.
12031461 // It must be a value obtained from the response of the previous DescribeLogGroups
12041462 // request.
1205 NextToken *string `locationName:"nextToken" type:"string"`
1463 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
12061464
12071465 metadataDescribeLogGroupsInput `json:"-" xml:"-"`
12081466 }
12281486 // A string token used for pagination that points to the next page of results.
12291487 // It must be a value obtained from the response of the previous request. The
12301488 // token expires after 24 hours.
1231 NextToken *string `locationName:"nextToken" type:"string"`
1489 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
12321490
12331491 metadataDescribeLogGroupsOutput `json:"-" xml:"-"`
12341492 }
12541512
12551513 // The maximum number of items returned in the response. If you don't specify
12561514 // a value, the request would return up to 50 items.
1257 Limit *int64 `locationName:"limit" type:"integer"`
1515 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
12581516
12591517 // The log group name for which log streams are to be listed.
1260 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1518 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
12611519
12621520 // Will only return log streams that match the provided logStreamNamePrefix.
12631521 // If you don't specify a value, no prefix filter is applied.
1264 LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" type:"string"`
1522 LogStreamNamePrefix *string `locationName:"logStreamNamePrefix" min:"1" type:"string"`
12651523
12661524 // A string token used for pagination that points to the next page of results.
12671525 // It must be a value obtained from the response of the previous DescribeLogStreams
12681526 // request.
1269 NextToken *string `locationName:"nextToken" type:"string"`
1527 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
12701528
12711529 // Specifies what to order the returned log streams by. Valid arguments are
12721530 // 'LogStreamName' or 'LastEventTime'. If you don't specify a value, results
12981556 // A string token used for pagination that points to the next page of results.
12991557 // It must be a value obtained from the response of the previous request. The
13001558 // token expires after 24 hours.
1301 NextToken *string `locationName:"nextToken" type:"string"`
1559 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
13021560
13031561 metadataDescribeLogStreamsOutput `json:"-" xml:"-"`
13041562 }
13201578 type DescribeMetricFiltersInput struct {
13211579 // Will only return metric filters that match the provided filterNamePrefix.
13221580 // If you don't specify a value, no prefix filter is applied.
1323 FilterNamePrefix *string `locationName:"filterNamePrefix" type:"string"`
1581 FilterNamePrefix *string `locationName:"filterNamePrefix" min:"1" type:"string"`
13241582
13251583 // The maximum number of items returned in the response. If you don't specify
13261584 // a value, the request would return up to 50 items.
1327 Limit *int64 `locationName:"limit" type:"integer"`
1585 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
13281586
13291587 // The log group name for which metric filters are to be listed.
1330 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1588 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
13311589
13321590 // A string token used for pagination that points to the next page of results.
13331591 // It must be a value obtained from the response of the previous DescribeMetricFilters
13341592 // request.
1335 NextToken *string `locationName:"nextToken" type:"string"`
1593 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
13361594
13371595 metadataDescribeMetricFiltersInput `json:"-" xml:"-"`
13381596 }
13571615 // A string token used for pagination that points to the next page of results.
13581616 // It must be a value obtained from the response of the previous request. The
13591617 // token expires after 24 hours.
1360 NextToken *string `locationName:"nextToken" type:"string"`
1618 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
13611619
13621620 metadataDescribeMetricFiltersOutput `json:"-" xml:"-"`
13631621 }
13791637 type DescribeSubscriptionFiltersInput struct {
13801638 // Will only return subscription filters that match the provided filterNamePrefix.
13811639 // If you don't specify a value, no prefix filter is applied.
1382 FilterNamePrefix *string `locationName:"filterNamePrefix" type:"string"`
1640 FilterNamePrefix *string `locationName:"filterNamePrefix" min:"1" type:"string"`
13831641
13841642 // The maximum number of results to return.
1385 Limit *int64 `locationName:"limit" type:"integer"`
1643 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
13861644
13871645 // The log group name for which subscription filters are to be listed.
1388 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1646 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
13891647
13901648 // A string token used for pagination that points to the next page of results.
13911649 // It must be a value obtained from the response of the previous request. The
13921650 // token expires after 24 hours.
1393 NextToken *string `locationName:"nextToken" type:"string"`
1651 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
13941652
13951653 metadataDescribeSubscriptionFiltersInput `json:"-" xml:"-"`
13961654 }
14131671 // A string token used for pagination that points to the next page of results.
14141672 // It must be a value obtained from the response of the previous request. The
14151673 // token expires after 24 hours.
1416 NextToken *string `locationName:"nextToken" type:"string"`
1674 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
14171675
14181676 SubscriptionFilters []*SubscriptionFilter `locationName:"subscriptionFilters" type:"list"`
14191677
14341692 return s.String()
14351693 }
14361694
1695 // A cross account destination that is the recipient of subscription log events.
14371696 type Destination struct {
1438 AccessPolicy *string `locationName:"accessPolicy" type:"string"`
1439
1697 // An IAM policy document that governs which AWS accounts can create subscription
1698 // filters against this destination.
1699 AccessPolicy *string `locationName:"accessPolicy" min:"1" type:"string"`
1700
1701 // ARN of this destination.
14401702 Arn *string `locationName:"arn" type:"string"`
14411703
14421704 // A point in time expressed as the number of milliseconds since Jan 1, 1970
1443 // 00:00:00 UTC.
1705 // 00:00:00 UTC specifying when this destination was created.
14441706 CreationTime *int64 `locationName:"creationTime" type:"long"`
14451707
1446 DestinationName *string `locationName:"destinationName" type:"string"`
1447
1448 RoleArn *string `locationName:"roleArn" type:"string"`
1449
1450 TargetArn *string `locationName:"targetArn" type:"string"`
1708 // Name of the destination.
1709 DestinationName *string `locationName:"destinationName" min:"1" type:"string"`
1710
1711 // A role for impersonation for delivering log events to the target.
1712 RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
1713
1714 // ARN of the physical target where the log events will be delivered (eg. ARN
1715 // of a Kinesis stream).
1716 TargetArn *string `locationName:"targetArn" min:"1" type:"string"`
14511717
14521718 metadataDestination `json:"-" xml:"-"`
14531719 }
14631729
14641730 // GoString returns the string representation
14651731 func (s Destination) GoString() string {
1732 return s.String()
1733 }
1734
1735 // Represents an export task.
1736 type ExportTask struct {
1737 // Name of Amazon S3 bucket to which the log data was exported.
1738 Destination *string `locationName:"destination" min:"1" type:"string"`
1739
1740 // Prefix that was used as the start of Amazon S3 key for every object exported.
1741 DestinationPrefix *string `locationName:"destinationPrefix" type:"string"`
1742
1743 // Execution info about the export task.
1744 ExecutionInfo *ExportTaskExecutionInfo `locationName:"executionInfo" type:"structure"`
1745
1746 // A unix timestamp indicating the start time of the range for the request.
1747 // Events with a timestamp prior to this time were not exported.
1748 From *int64 `locationName:"from" type:"long"`
1749
1750 // The name of the log group from which logs data was exported.
1751 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`
1752
1753 // Status of the export task.
1754 Status *ExportTaskStatus `locationName:"status" type:"structure"`
1755
1756 // Id of the export task.
1757 TaskId *string `locationName:"taskId" min:"1" type:"string"`
1758
1759 // The name of the export task.
1760 TaskName *string `locationName:"taskName" min:"1" type:"string"`
1761
1762 // A unix timestamp indicating the end time of the range for the request. Events
1763 // with a timestamp later than this time were not exported.
1764 To *int64 `locationName:"to" type:"long"`
1765
1766 metadataExportTask `json:"-" xml:"-"`
1767 }
1768
1769 type metadataExportTask struct {
1770 SDKShapeTraits bool `type:"structure"`
1771 }
1772
1773 // String returns the string representation
1774 func (s ExportTask) String() string {
1775 return awsutil.Prettify(s)
1776 }
1777
1778 // GoString returns the string representation
1779 func (s ExportTask) GoString() string {
1780 return s.String()
1781 }
1782
1783 // Represents the status of an export task.
1784 type ExportTaskExecutionInfo struct {
1785 // A point in time when the export task got completed.
1786 CompletionTime *int64 `locationName:"completionTime" type:"long"`
1787
1788 // A point in time when the export task got created.
1789 CreationTime *int64 `locationName:"creationTime" type:"long"`
1790
1791 metadataExportTaskExecutionInfo `json:"-" xml:"-"`
1792 }
1793
1794 type metadataExportTaskExecutionInfo struct {
1795 SDKShapeTraits bool `type:"structure"`
1796 }
1797
1798 // String returns the string representation
1799 func (s ExportTaskExecutionInfo) String() string {
1800 return awsutil.Prettify(s)
1801 }
1802
1803 // GoString returns the string representation
1804 func (s ExportTaskExecutionInfo) GoString() string {
1805 return s.String()
1806 }
1807
1808 // Represents the status of an export task.
1809 type ExportTaskStatus struct {
1810 // Status code of the export task.
1811 Code *string `locationName:"code" type:"string" enum:"ExportTaskStatusCode"`
1812
1813 // Status message related to the code.
1814 Message *string `locationName:"message" type:"string"`
1815
1816 metadataExportTaskStatus `json:"-" xml:"-"`
1817 }
1818
1819 type metadataExportTaskStatus struct {
1820 SDKShapeTraits bool `type:"structure"`
1821 }
1822
1823 // String returns the string representation
1824 func (s ExportTaskStatus) String() string {
1825 return awsutil.Prettify(s)
1826 }
1827
1828 // GoString returns the string representation
1829 func (s ExportTaskStatus) GoString() string {
14661830 return s.String()
14671831 }
14681832
14831847
14841848 // The maximum number of events to return in a page of results. Default is 10,000
14851849 // events.
1486 Limit *int64 `locationName:"limit" type:"integer"`
1850 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
14871851
14881852 // The name of the log group to query.
1489 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1853 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
14901854
14911855 // Optional list of log stream names within the specified log group to search.
14921856 // Defaults to all the log streams in the log group.
1493 LogStreamNames []*string `locationName:"logStreamNames" type:"list"`
1857 LogStreamNames []*string `locationName:"logStreamNames" min:"1" type:"list"`
14941858
14951859 // A pagination token obtained from a FilterLogEvents response to continue paginating
14961860 // the FilterLogEvents results.
1497 NextToken *string `locationName:"nextToken" type:"string"`
1861 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
14981862
14991863 // A unix timestamp indicating the start time of the range for the request.
15001864 // If provided, events with a timestamp prior to this time will not be returned.
15241888
15251889 // A pagination token obtained from a FilterLogEvents response to continue paginating
15261890 // the FilterLogEvents results.
1527 NextToken *string `locationName:"nextToken" type:"string"`
1891 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
15281892
15291893 // A list of SearchedLogStream objects indicating which log streams have been
15301894 // searched in this request and whether each has been searched completely or
15581922 IngestionTime *int64 `locationName:"ingestionTime" type:"long"`
15591923
15601924 // The name of the log stream this event belongs to.
1561 LogStreamName *string `locationName:"logStreamName" type:"string"`
1925 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`
15621926
15631927 // The data contained in the log event.
1564 Message *string `locationName:"message" type:"string"`
1928 Message *string `locationName:"message" min:"1" type:"string"`
15651929
15661930 // A point in time expressed as the number of milliseconds since Jan 1, 1970
15671931 // 00:00:00 UTC.
15921956 // The maximum number of log events returned in the response. If you don't specify
15931957 // a value, the request would return as many log events as can fit in a response
15941958 // size of 1MB, up to 10,000 log events.
1595 Limit *int64 `locationName:"limit" type:"integer"`
1959 Limit *int64 `locationName:"limit" min:"1" type:"integer"`
15961960
15971961 // The name of the log group to query.
1598 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
1962 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
15991963
16001964 // The name of the log stream to query.
1601 LogStreamName *string `locationName:"logStreamName" type:"string" required:"true"`
1965 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
16021966
16031967 // A string token used for pagination that points to the next page of results.
16041968 // It must be a value obtained from the nextForwardToken or nextBackwardToken
16051969 // fields in the response of the previous GetLogEvents request.
1606 NextToken *string `locationName:"nextToken" type:"string"`
1970 NextToken *string `locationName:"nextToken" min:"1" type:"string"`
16071971
16081972 // If set to true, the earliest log events would be returned first. The default
16091973 // is false (the latest log events are returned first).
16362000 // A string token used for pagination that points to the next page of results.
16372001 // It must be a value obtained from the response of the previous request. The
16382002 // token expires after 24 hours.
1639 NextBackwardToken *string `locationName:"nextBackwardToken" type:"string"`
2003 NextBackwardToken *string `locationName:"nextBackwardToken" min:"1" type:"string"`
16402004
16412005 // A string token used for pagination that points to the next page of results.
16422006 // It must be a value obtained from the response of the previous request. The
16432007 // token expires after 24 hours.
1644 NextForwardToken *string `locationName:"nextForwardToken" type:"string"`
2008 NextForwardToken *string `locationName:"nextForwardToken" min:"1" type:"string"`
16452009
16462010 metadataGetLogEventsOutput `json:"-" xml:"-"`
16472011 }
16652029 // Logs understands contains two properties: the timestamp of when the event
16662030 // occurred, and the raw event message.
16672031 type InputLogEvent struct {
1668 Message *string `locationName:"message" type:"string" required:"true"`
2032 Message *string `locationName:"message" min:"1" type:"string" required:"true"`
16692033
16702034 // A point in time expressed as the number of milliseconds since Jan 1, 1970
16712035 // 00:00:00 UTC.
16952059 // 00:00:00 UTC.
16962060 CreationTime *int64 `locationName:"creationTime" type:"long"`
16972061
1698 LogGroupName *string `locationName:"logGroupName" type:"string"`
2062 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`
16992063
17002064 // The number of metric filters associated with the log group.
17012065 MetricFilterCount *int64 `locationName:"metricFilterCount" type:"integer"`
17442108 // 00:00:00 UTC.
17452109 LastIngestionTime *int64 `locationName:"lastIngestionTime" type:"long"`
17462110
1747 LogStreamName *string `locationName:"logStreamName" type:"string"`
2111 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`
17482112
17492113 StoredBytes *int64 `locationName:"storedBytes" type:"long"`
17502114
17512115 // A string token used for making PutLogEvents requests. A sequenceToken can
17522116 // only be used once, and PutLogEvents requests must include the sequenceToken
17532117 // obtained from the response of the previous request.
1754 UploadSequenceToken *string `locationName:"uploadSequenceToken" type:"string"`
2118 UploadSequenceToken *string `locationName:"uploadSequenceToken" min:"1" type:"string"`
17552119
17562120 metadataLogStream `json:"-" xml:"-"`
17572121 }
17792143 CreationTime *int64 `locationName:"creationTime" type:"long"`
17802144
17812145 // A name for a metric or subscription filter.
1782 FilterName *string `locationName:"filterName" type:"string"`
2146 FilterName *string `locationName:"filterName" min:"1" type:"string"`
17832147
17842148 // A symbolic description of how Amazon CloudWatch Logs should interpret the
17852149 // data in each log event. For example, a log event may contain timestamps,
17872151 // to look for in the log event message.
17882152 FilterPattern *string `locationName:"filterPattern" type:"string"`
17892153
1790 MetricTransformations []*MetricTransformation `locationName:"metricTransformations" type:"list"`
2154 MetricTransformations []*MetricTransformation `locationName:"metricTransformations" min:"1" type:"list"`
17912155
17922156 metadataMetricFilter `json:"-" xml:"-"`
17932157 }
18072171 }
18082172
18092173 type MetricFilterMatchRecord struct {
1810 EventMessage *string `locationName:"eventMessage" type:"string"`
2174 EventMessage *string `locationName:"eventMessage" min:"1" type:"string"`
18112175
18122176 EventNumber *int64 `locationName:"eventNumber" type:"long"`
18132177
18662230 // 00:00:00 UTC.
18672231 IngestionTime *int64 `locationName:"ingestionTime" type:"long"`
18682232
1869 Message *string `locationName:"message" type:"string"`
2233 Message *string `locationName:"message" min:"1" type:"string"`
18702234
18712235 // A point in time expressed as the number of milliseconds since Jan 1, 1970
18722236 // 00:00:00 UTC.
18912255
18922256 type PutDestinationInput struct {
18932257 // A name for the destination.
1894 DestinationName *string `locationName:"destinationName" type:"string" required:"true"`
2258 DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`
18952259
18962260 // The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to
18972261 // do Amazon Kinesis PutRecord requests on the desitnation stream.
1898 RoleArn *string `locationName:"roleArn" type:"string" required:"true"`
2262 RoleArn *string `locationName:"roleArn" min:"1" type:"string" required:"true"`
18992263
19002264 // The ARN of an Amazon Kinesis stream to deliver matching log events to.
1901 TargetArn *string `locationName:"targetArn" type:"string" required:"true"`
2265 TargetArn *string `locationName:"targetArn" min:"1" type:"string" required:"true"`
19022266
19032267 metadataPutDestinationInput `json:"-" xml:"-"`
19042268 }
19182282 }
19192283
19202284 type PutDestinationOutput struct {
2285 // A cross account destination that is the recipient of subscription log events.
19212286 Destination *Destination `locationName:"destination" type:"structure"`
19222287
19232288 metadataPutDestinationOutput `json:"-" xml:"-"`
19402305 type PutDestinationPolicyInput struct {
19412306 // An IAM policy document that authorizes cross-account users to deliver their
19422307 // log events to associated destination.
1943 AccessPolicy *string `locationName:"accessPolicy" type:"string" required:"true"`
2308 AccessPolicy *string `locationName:"accessPolicy" min:"1" type:"string" required:"true"`
19442309
19452310 // A name for an existing destination.
1946 DestinationName *string `locationName:"destinationName" type:"string" required:"true"`
2311 DestinationName *string `locationName:"destinationName" min:"1" type:"string" required:"true"`
19472312
19482313 metadataPutDestinationPolicyInput `json:"-" xml:"-"`
19492314 }
19822347
19832348 type PutLogEventsInput struct {
19842349 // A list of log events belonging to a log stream.
1985 LogEvents []*InputLogEvent `locationName:"logEvents" type:"list" required:"true"`
2350 LogEvents []*InputLogEvent `locationName:"logEvents" min:"1" type:"list" required:"true"`
19862351
19872352 // The name of the log group to put log events to.
1988 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
2353 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
19892354
19902355 // The name of the log stream to put log events to.
1991 LogStreamName *string `locationName:"logStreamName" type:"string" required:"true"`
2356 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string" required:"true"`
19922357
19932358 // A string token that must be obtained from the response of the previous PutLogEvents
19942359 // request.
1995 SequenceToken *string `locationName:"sequenceToken" type:"string"`
2360 SequenceToken *string `locationName:"sequenceToken" min:"1" type:"string"`
19962361
19972362 metadataPutLogEventsInput `json:"-" xml:"-"`
19982363 }
20152380 // A string token used for making PutLogEvents requests. A sequenceToken can
20162381 // only be used once, and PutLogEvents requests must include the sequenceToken
20172382 // obtained from the response of the previous request.
2018 NextSequenceToken *string `locationName:"nextSequenceToken" type:"string"`
2383 NextSequenceToken *string `locationName:"nextSequenceToken" min:"1" type:"string"`
20192384
20202385 RejectedLogEventsInfo *RejectedLogEventsInfo `locationName:"rejectedLogEventsInfo" type:"structure"`
20212386
20382403
20392404 type PutMetricFilterInput struct {
20402405 // A name for the metric filter.
2041 FilterName *string `locationName:"filterName" type:"string" required:"true"`
2406 FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`
20422407
20432408 // A valid CloudWatch Logs filter pattern for extracting metric data out of
20442409 // ingested log events.
20452410 FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`
20462411
20472412 // The name of the log group to associate the metric filter with.
2048 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
2413 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
20492414
20502415 // A collection of information needed to define how metric data gets emitted.
2051 MetricTransformations []*MetricTransformation `locationName:"metricTransformations" type:"list" required:"true"`
2416 MetricTransformations []*MetricTransformation `locationName:"metricTransformations" min:"1" type:"list" required:"true"`
20522417
20532418 metadataPutMetricFilterInput `json:"-" xml:"-"`
20542419 }
20872452
20882453 type PutRetentionPolicyInput struct {
20892454 // The name of the log group to associate the retention policy with.
2090 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
2455 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
20912456
20922457 // Specifies the number of days you want to retain log events in the specified
20932458 // log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180,
21352500 // same account as the subscription filter, for same-account delivery. A logical
21362501 // destination (used via an ARN of Destination) belonging to a different account,
21372502 // for cross-account delivery.
2138 DestinationArn *string `locationName:"destinationArn" type:"string" required:"true"`
2503 DestinationArn *string `locationName:"destinationArn" min:"1" type:"string" required:"true"`
21392504
21402505 // A name for the subscription filter.
2141 FilterName *string `locationName:"filterName" type:"string" required:"true"`
2506 FilterName *string `locationName:"filterName" min:"1" type:"string" required:"true"`
21422507
21432508 // A valid CloudWatch Logs filter pattern for subscribing to a filtered stream
21442509 // of log events.
21452510 FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`
21462511
21472512 // The name of the log group to associate the subscription filter with.
2148 LogGroupName *string `locationName:"logGroupName" type:"string" required:"true"`
2513 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string" required:"true"`
21492514
21502515 // The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to
21512516 // deliver ingested log events to the destination stream. You don't need to
21522517 // provide the ARN when you are working with a logical destination (used via
21532518 // an ARN of Destination) for cross-account delivery.
2154 RoleArn *string `locationName:"roleArn" type:"string"`
2519 RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
21552520
21562521 metadataPutSubscriptionFilterInput `json:"-" xml:"-"`
21572522 }
22162581 // request.
22172582 type SearchedLogStream struct {
22182583 // The name of the log stream.
2219 LogStreamName *string `locationName:"logStreamName" type:"string"`
2584 LogStreamName *string `locationName:"logStreamName" min:"1" type:"string"`
22202585
22212586 // Indicates whether all the events in this log stream were searched or more
22222587 // data exists to search by paginating further.
22442609 // 00:00:00 UTC.
22452610 CreationTime *int64 `locationName:"creationTime" type:"long"`
22462611
2247 DestinationArn *string `locationName:"destinationArn" type:"string"`
2612 DestinationArn *string `locationName:"destinationArn" min:"1" type:"string"`
22482613
22492614 // A name for a metric or subscription filter.
2250 FilterName *string `locationName:"filterName" type:"string"`
2615 FilterName *string `locationName:"filterName" min:"1" type:"string"`
22512616
22522617 // A symbolic description of how Amazon CloudWatch Logs should interpret the
22532618 // data in each log event. For example, a log event may contain timestamps,
22552620 // to look for in the log event message.
22562621 FilterPattern *string `locationName:"filterPattern" type:"string"`
22572622
2258 LogGroupName *string `locationName:"logGroupName" type:"string"`
2259
2260 RoleArn *string `locationName:"roleArn" type:"string"`
2623 LogGroupName *string `locationName:"logGroupName" min:"1" type:"string"`
2624
2625 RoleArn *string `locationName:"roleArn" min:"1" type:"string"`
22612626
22622627 metadataSubscriptionFilter `json:"-" xml:"-"`
22632628 }
22842649 FilterPattern *string `locationName:"filterPattern" type:"string" required:"true"`
22852650
22862651 // A list of log event messages to test.
2287 LogEventMessages []*string `locationName:"logEventMessages" type:"list" required:"true"`
2652 LogEventMessages []*string `locationName:"logEventMessages" min:"1" type:"list" required:"true"`
22882653
22892654 metadataTestMetricFilterInput `json:"-" xml:"-"`
22902655 }
23222687 func (s TestMetricFilterOutput) GoString() string {
23232688 return s.String()
23242689 }
2690
2691 const (
2692 // @enum ExportTaskStatusCode
2693 ExportTaskStatusCodeCancelled = "CANCELLED"
2694 // @enum ExportTaskStatusCode
2695 ExportTaskStatusCodeCompleted = "COMPLETED"
2696 // @enum ExportTaskStatusCode
2697 ExportTaskStatusCodeFailed = "FAILED"
2698 // @enum ExportTaskStatusCode
2699 ExportTaskStatusCodePending = "PENDING"
2700 // @enum ExportTaskStatusCode
2701 ExportTaskStatusCodePendingCancel = "PENDING_CANCEL"
2702 // @enum ExportTaskStatusCode
2703 ExportTaskStatusCodeRunning = "RUNNING"
2704 )
23252705
23262706 const (
23272707 // @enum OrderBy
+12
-0
service/cloudwatchlogs/cloudwatchlogsiface/interface.go less more
99
1010 // CloudWatchLogsAPI is the interface type for cloudwatchlogs.CloudWatchLogs.
1111 type CloudWatchLogsAPI interface {
12 CancelExportTaskRequest(*cloudwatchlogs.CancelExportTaskInput) (*request.Request, *cloudwatchlogs.CancelExportTaskOutput)
13
14 CancelExportTask(*cloudwatchlogs.CancelExportTaskInput) (*cloudwatchlogs.CancelExportTaskOutput, error)
15
16 CreateExportTaskRequest(*cloudwatchlogs.CreateExportTaskInput) (*request.Request, *cloudwatchlogs.CreateExportTaskOutput)
17
18 CreateExportTask(*cloudwatchlogs.CreateExportTaskInput) (*cloudwatchlogs.CreateExportTaskOutput, error)
19
1220 CreateLogGroupRequest(*cloudwatchlogs.CreateLogGroupInput) (*request.Request, *cloudwatchlogs.CreateLogGroupOutput)
1321
1422 CreateLogGroup(*cloudwatchlogs.CreateLogGroupInput) (*cloudwatchlogs.CreateLogGroupOutput, error)
4654 DescribeDestinations(*cloudwatchlogs.DescribeDestinationsInput) (*cloudwatchlogs.DescribeDestinationsOutput, error)
4755
4856 DescribeDestinationsPages(*cloudwatchlogs.DescribeDestinationsInput, func(*cloudwatchlogs.DescribeDestinationsOutput, bool) bool) error
57
58 DescribeExportTasksRequest(*cloudwatchlogs.DescribeExportTasksInput) (*request.Request, *cloudwatchlogs.DescribeExportTasksOutput)
59
60 DescribeExportTasks(*cloudwatchlogs.DescribeExportTasksInput) (*cloudwatchlogs.DescribeExportTasksOutput, error)
4961
5062 DescribeLogGroupsRequest(*cloudwatchlogs.DescribeLogGroupsInput) (*request.Request, *cloudwatchlogs.DescribeLogGroupsOutput)
5163
+66
-0
service/cloudwatchlogs/examples_test.go less more
1313 var _ time.Duration
1414 var _ bytes.Buffer
1515
16 func ExampleCloudWatchLogs_CancelExportTask() {
17 svc := cloudwatchlogs.New(nil)
18
19 params := &cloudwatchlogs.CancelExportTaskInput{
20 TaskId: aws.String("ExportTaskId"), // Required
21 }
22 resp, err := svc.CancelExportTask(params)
23
24 if err != nil {
25 // Print the error, cast err to awserr.Error to get the Code and
26 // Message from an error.
27 fmt.Println(err.Error())
28 return
29 }
30
31 // Pretty-print the response data.
32 fmt.Println(resp)
33 }
34
35 func ExampleCloudWatchLogs_CreateExportTask() {
36 svc := cloudwatchlogs.New(nil)
37
38 params := &cloudwatchlogs.CreateExportTaskInput{
39 Destination: aws.String("ExportDestinationBucket"), // Required
40 From: aws.Int64(1), // Required
41 LogGroupName: aws.String("LogGroupName"), // Required
42 To: aws.Int64(1), // Required
43 DestinationPrefix: aws.String("ExportDestinationPrefix"),
44 LogStreamNamePrefix: aws.String("LogStreamName"),
45 TaskName: aws.String("ExportTaskName"),
46 }
47 resp, err := svc.CreateExportTask(params)
48
49 if err != nil {
50 // Print the error, cast err to awserr.Error to get the Code and
51 // Message from an error.
52 fmt.Println(err.Error())
53 return
54 }
55
56 // Pretty-print the response data.
57 fmt.Println(resp)
58 }
59
1660 func ExampleCloudWatchLogs_CreateLogGroup() {
1761 svc := cloudwatchlogs.New(nil)
1862
178222 NextToken: aws.String("NextToken"),
179223 }
180224 resp, err := svc.DescribeDestinations(params)
225
226 if err != nil {
227 // Print the error, cast err to awserr.Error to get the Code and
228 // Message from an error.
229 fmt.Println(err.Error())
230 return
231 }
232
233 // Pretty-print the response data.
234 fmt.Println(resp)
235 }
236
237 func ExampleCloudWatchLogs_DescribeExportTasks() {
238 svc := cloudwatchlogs.New(nil)
239
240 params := &cloudwatchlogs.DescribeExportTasksInput{
241 Limit: aws.Int64(1),
242 NextToken: aws.String("NextToken"),
243 StatusCode: aws.String("ExportTaskStatusCode"),
244 TaskId: aws.String("ExportTaskId"),
245 }
246 resp, err := svc.DescribeExportTasks(params)
181247
182248 if err != nil {
183249 // Print the error, cast err to awserr.Error to get the Code and
+17
-17
service/codecommit/api.go less more
387387 // Returns information about a branch.
388388 type BranchInfo struct {
389389 // The name of the branch.
390 BranchName *string `locationName:"branchName" type:"string"`
390 BranchName *string `locationName:"branchName" min:"1" type:"string"`
391391
392392 // The ID of the last commit made to the branch.
393393 CommitId *string `locationName:"commitId" type:"string"`
412412 // Represents the input of a create branch operation.
413413 type CreateBranchInput struct {
414414 // The name of the new branch to create.
415 BranchName *string `locationName:"branchName" type:"string" required:"true"`
415 BranchName *string `locationName:"branchName" min:"1" type:"string" required:"true"`
416416
417417 // The ID of the commit to point the new branch to.
418418 //
421421 CommitId *string `locationName:"commitId" type:"string" required:"true"`
422422
423423 // The name of the repository in which you want to create the new branch.
424 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
424 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
425425
426426 metadataCreateBranchInput `json:"-" xml:"-"`
427427 }
468468 // The repository name must be unique across the calling AWS account. In addition,
469469 // repository names are restricted to alphanumeric characters. The suffix ".git"
470470 // is prohibited.
471 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
471 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
472472
473473 metadataCreateRepositoryInput `json:"-" xml:"-"`
474474 }
512512 // Represents the input of a delete repository operation.
513513 type DeleteRepositoryInput struct {
514514 // The name of the repository to delete.
515 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
515 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
516516
517517 metadataDeleteRepositoryInput `json:"-" xml:"-"`
518518 }
556556 // Represents the input of a get branch operation.
557557 type GetBranchInput struct {
558558 // The name of the branch for which you want to retrieve information.
559 BranchName *string `locationName:"branchName" type:"string"`
559 BranchName *string `locationName:"branchName" min:"1" type:"string"`
560560
561561 // Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
562562 // ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
563563 // name.
564 RepositoryName *string `locationName:"repositoryName" type:"string"`
564 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
565565
566566 metadataGetBranchInput `json:"-" xml:"-"`
567567 }
605605 // Represents the input of a get repository operation.
606606 type GetRepositoryInput struct {
607607 // The name of the repository to get information about.
608 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
608 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
609609
610610 metadataGetRepositoryInput `json:"-" xml:"-"`
611611 }
652652 NextToken *string `locationName:"nextToken" type:"string"`
653653
654654 // The name of the repository that contains the branches.
655 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
655 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
656656
657657 metadataListBranchesInput `json:"-" xml:"-"`
658658 }
773773 CreationDate *time.Time `locationName:"creationDate" type:"timestamp" timestampFormat:"unix"`
774774
775775 // The repository's default branch name.
776 DefaultBranch *string `locationName:"defaultBranch" type:"string"`
776 DefaultBranch *string `locationName:"defaultBranch" min:"1" type:"string"`
777777
778778 // The date and time the repository was last modified, in timestamp format.
779779 LastModifiedDate *time.Time `locationName:"lastModifiedDate" type:"timestamp" timestampFormat:"unix"`
785785 RepositoryId *string `locationName:"repositoryId" type:"string"`
786786
787787 // The repository's name.
788 RepositoryName *string `locationName:"repositoryName" type:"string"`
788 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
789789
790790 metadataRepositoryMetadata `json:"-" xml:"-"`
791791 }
812812 // Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
813813 // ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
814814 // name.
815 RepositoryName *string `locationName:"repositoryName" type:"string"`
815 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string"`
816816
817817 metadataRepositoryNameIdPair `json:"-" xml:"-"`
818818 }
834834 // Represents the input of an update default branch operation.
835835 type UpdateDefaultBranchInput struct {
836836 // The name of the branch to set as the default.
837 DefaultBranchName *string `locationName:"defaultBranchName" type:"string" required:"true"`
837 DefaultBranchName *string `locationName:"defaultBranchName" min:"1" type:"string" required:"true"`
838838
839839 // The name of the repository to set or change the default branch for.
840 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
840 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
841841
842842 metadataUpdateDefaultBranchInput `json:"-" xml:"-"`
843843 }
880880 RepositoryDescription *string `locationName:"repositoryDescription" type:"string"`
881881
882882 // The name of the repository to set or change the comment or description for.
883 RepositoryName *string `locationName:"repositoryName" type:"string" required:"true"`
883 RepositoryName *string `locationName:"repositoryName" min:"1" type:"string" required:"true"`
884884
885885 metadataUpdateRepositoryDescriptionInput `json:"-" xml:"-"`
886886 }
922922 // Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
923923 // ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
924924 // name.
925 NewName *string `locationName:"newName" type:"string" required:"true"`
925 NewName *string `locationName:"newName" min:"1" type:"string" required:"true"`
926926
927927 // Repository name is restricted to alphanumeric characters (a-z, A-Z, 0-9),
928928 // ".", "_", and "-". Additionally, the suffix ".git" is prohibited in a repository
929929 // name.
930 OldName *string `locationName:"oldName" type:"string" required:"true"`
930 OldName *string `locationName:"oldName" min:"1" type:"string" required:"true"`
931931
932932 metadataUpdateRepositoryNameInput `json:"-" xml:"-"`
933933 }
+38
-38
service/codedeploy/api.go less more
10131013 ApplicationId *string `locationName:"applicationId" type:"string"`
10141014
10151015 // The application name.
1016 ApplicationName *string `locationName:"applicationName" type:"string"`
1016 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
10171017
10181018 // The time that the application was created.
10191019 CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"unix"`
12011201 type CreateApplicationInput struct {
12021202 // The name of the application. This name must be unique with the applicable
12031203 // IAM user or AWS account.
1204 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1204 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
12051205
12061206 metadataCreateApplicationInput `json:"-" xml:"-"`
12071207 }
12451245 // Represents the input of a create deployment configuration operation.
12461246 type CreateDeploymentConfigInput struct {
12471247 // The name of the deployment configuration to create.
1248 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string" required:"true"`
1248 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string" required:"true"`
12491249
12501250 // The minimum number of healthy instances that should be available at any time
12511251 // during the deployment. There are two parameters expected in the input: type
13081308 type CreateDeploymentGroupInput struct {
13091309 // The name of an existing AWS CodeDeploy application associated with the applicable
13101310 // IAM user or AWS account.
1311 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1311 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
13121312
13131313 // A list of associated Auto Scaling groups.
13141314 AutoScalingGroups []*string `locationName:"autoScalingGroups" type:"list"`
13421342 // specified for either the deployment or the deployment group. To create a
13431343 // custom deployment configuration, call the create deployment configuration
13441344 // operation.
1345 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
1345 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
13461346
13471347 // The name of an existing deployment group for the specified application.
1348 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string" required:"true"`
1348 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string" required:"true"`
13491349
13501350 // The Amazon EC2 tags to filter on.
13511351 Ec2TagFilters []*EC2TagFilter `locationName:"ec2TagFilters" type:"list"`
14001400 type CreateDeploymentInput struct {
14011401 // The name of an existing AWS CodeDeploy application associated with the applicable
14021402 // IAM user or AWS account.
1403 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1403 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
14041404
14051405 // The name of an existing deployment configuration associated with the applicable
14061406 // IAM user or AWS account.
14081408 // If not specified, the value configured in the deployment group will be used
14091409 // as the default. If the deployment group does not have a deployment configuration
14101410 // associated with it, then CodeDeployDefault.OneAtATime will be used by default.
1411 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
1411 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
14121412
14131413 // The deployment group's name.
1414 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string"`
1414 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string"`
14151415
14161416 // A comment about the deployment.
14171417 Description *string `locationName:"description" type:"string"`
14741474 type DeleteApplicationInput struct {
14751475 // The name of an existing AWS CodeDeploy application associated with the applicable
14761476 // IAM user or AWS account.
1477 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1477 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
14781478
14791479 metadataDeleteApplicationInput `json:"-" xml:"-"`
14801480 }
15151515 type DeleteDeploymentConfigInput struct {
15161516 // The name of an existing deployment configuration associated with the applicable
15171517 // IAM user or AWS account.
1518 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string" required:"true"`
1518 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string" required:"true"`
15191519
15201520 metadataDeleteDeploymentConfigInput `json:"-" xml:"-"`
15211521 }
15561556 type DeleteDeploymentGroupInput struct {
15571557 // The name of an existing AWS CodeDeploy application associated with the applicable
15581558 // IAM user or AWS account.
1559 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1559 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
15601560
15611561 // The name of an existing deployment group for the specified application.
1562 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string" required:"true"`
1562 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string" required:"true"`
15631563
15641564 metadataDeleteDeploymentGroupInput `json:"-" xml:"-"`
15651565 }
16141614 DeploymentConfigId *string `locationName:"deploymentConfigId" type:"string"`
16151615
16161616 // The deployment configuration name.
1617 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
1617 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
16181618
16191619 // Information about the number or percentage of minimum healthy instances.
16201620 MinimumHealthyHosts *MinimumHealthyHosts `locationName:"minimumHealthyHosts" type:"structure"`
16391639 // Information about a deployment group.
16401640 type DeploymentGroupInfo struct {
16411641 // The application name.
1642 ApplicationName *string `locationName:"applicationName" type:"string"`
1642 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
16431643
16441644 // A list of associated Auto Scaling groups.
16451645 AutoScalingGroups []*AutoScalingGroup `locationName:"autoScalingGroups" type:"list"`
16461646
16471647 // The deployment configuration name.
1648 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
1648 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
16491649
16501650 // The deployment group ID.
16511651 DeploymentGroupId *string `locationName:"deploymentGroupId" type:"string"`
16521652
16531653 // The deployment group name.
1654 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string"`
1654 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string"`
16551655
16561656 // The Amazon EC2 tags to filter on.
16571657 Ec2TagFilters []*EC2TagFilter `locationName:"ec2TagFilters" type:"list"`
16861686 // Information about a deployment.
16871687 type DeploymentInfo struct {
16881688 // The application name.
1689 ApplicationName *string `locationName:"applicationName" type:"string"`
1689 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
16901690
16911691 // A timestamp indicating when the deployment was completed.
16921692 CompleteTime *time.Time `locationName:"completeTime" type:"timestamp" timestampFormat:"unix"`
17011701 Creator *string `locationName:"creator" type:"string" enum:"DeploymentCreator"`
17021702
17031703 // The deployment configuration name.
1704 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
1704 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
17051705
17061706 // The deployment group name.
1707 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string"`
1707 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string"`
17081708
17091709 // The deployment ID.
17101710 DeploymentId *string `locationName:"deploymentId" type:"string"`
19861986 type GetApplicationInput struct {
19871987 // The name of an existing AWS CodeDeploy application associated with the applicable
19881988 // IAM user or AWS account.
1989 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
1989 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
19901990
19911991 metadataGetApplicationInput `json:"-" xml:"-"`
19921992 }
20302030 // Represents the input of a get application revision operation.
20312031 type GetApplicationRevisionInput struct {
20322032 // The name of the application that corresponds to the revision.
2033 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
2033 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
20342034
20352035 // Information about the application revision to get, including the revision's
20362036 // type and its location.
20562056 // Represents the output of a get application revision operation.
20572057 type GetApplicationRevisionOutput struct {
20582058 // The name of the application that corresponds to the revision.
2059 ApplicationName *string `locationName:"applicationName" type:"string"`
2059 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
20602060
20612061 // Additional information about the revision, including the revision's type
20622062 // and its location.
20862086 type GetDeploymentConfigInput struct {
20872087 // The name of an existing deployment configuration associated with the applicable
20882088 // IAM user or AWS account.
2089 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string" required:"true"`
2089 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string" required:"true"`
20902090
20912091 metadataGetDeploymentConfigInput `json:"-" xml:"-"`
20922092 }
21312131 type GetDeploymentGroupInput struct {
21322132 // The name of an existing AWS CodeDeploy application associated with the applicable
21332133 // IAM user or AWS account.
2134 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
2134 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
21352135
21362136 // The name of an existing deployment group for the specified application.
2137 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string" required:"true"`
2137 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string" required:"true"`
21382138
21392139 metadataGetDeploymentGroupInput `json:"-" xml:"-"`
21402140 }
24642464 type ListApplicationRevisionsInput struct {
24652465 // The name of an existing AWS CodeDeploy application associated with the applicable
24662466 // IAM user or AWS account.
2467 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
2467 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
24682468
24692469 // Whether to list revisions based on whether the revision is the target revision
24702470 // of an deployment group:
26582658 type ListDeploymentGroupsInput struct {
26592659 // The name of an existing AWS CodeDeploy application associated with the applicable
26602660 // IAM user or AWS account.
2661 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
2661 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
26622662
26632663 // An identifier that was returned from the previous list deployment groups
26642664 // call, which can be used to return the next set of deployment groups in the
26852685 // Represents the output of a list deployment groups operation.
26862686 type ListDeploymentGroupsOutput struct {
26872687 // The application name.
2688 ApplicationName *string `locationName:"applicationName" type:"string"`
2688 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
26892689
26902690 // A list of corresponding deployment group names.
26912691 DeploymentGroups []*string `locationName:"deploymentGroups" type:"list"`
27832783 type ListDeploymentsInput struct {
27842784 // The name of an existing AWS CodeDeploy application associated with the applicable
27852785 // IAM user or AWS account.
2786 ApplicationName *string `locationName:"applicationName" type:"string"`
2786 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
27872787
27882788 // A deployment creation start- and end-time range for returning a subset of
27892789 // the list of deployments.
27902790 CreateTimeRange *TimeRange `locationName:"createTimeRange" type:"structure"`
27912791
27922792 // The name of an existing deployment group for the specified application.
2793 DeploymentGroupName *string `locationName:"deploymentGroupName" type:"string"`
2793 DeploymentGroupName *string `locationName:"deploymentGroupName" min:"1" type:"string"`
27942794
27952795 // A subset of deployments to list, by status:
27962796 //
29562956 type RegisterApplicationRevisionInput struct {
29572957 // The name of an existing AWS CodeDeploy application associated with the applicable
29582958 // IAM user or AWS account.
2959 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
2959 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
29602960
29612961 // A comment about the revision.
29622962 Description *string `locationName:"description" type:"string"`
33023302 // Represents the input of an update application operation.
33033303 type UpdateApplicationInput struct {
33043304 // The current name of the application that you want to change.
3305 ApplicationName *string `locationName:"applicationName" type:"string"`
3305 ApplicationName *string `locationName:"applicationName" min:"1" type:"string"`
33063306
33073307 // The new name that you want to change the application to.
3308 NewApplicationName *string `locationName:"newApplicationName" type:"string"`
3308 NewApplicationName *string `locationName:"newApplicationName" min:"1" type:"string"`
33093309
33103310 metadataUpdateApplicationInput `json:"-" xml:"-"`
33113311 }
33453345 // Represents the input of an update deployment group operation.
33463346 type UpdateDeploymentGroupInput struct {
33473347 // The application name corresponding to the deployment group to update.
3348 ApplicationName *string `locationName:"applicationName" type:"string" required:"true"`
3348 ApplicationName *string `locationName:"applicationName" min:"1" type:"string" required:"true"`
33493349
33503350 // The replacement list of Auto Scaling groups to be included in the deployment
33513351 // group, if you want to change them.
33523352 AutoScalingGroups []*string `locationName:"autoScalingGroups" type:"list"`
33533353
33543354 // The current name of the existing deployment group.
3355 CurrentDeploymentGroupName *string `locationName:"currentDeploymentGroupName" type:"string" required:"true"`
3355 CurrentDeploymentGroupName *string `locationName:"currentDeploymentGroupName" min:"1" type:"string" required:"true"`
33563356
33573357 // The replacement deployment configuration name to use, if you want to change
33583358 // it.
3359 DeploymentConfigName *string `locationName:"deploymentConfigName" type:"string"`
3359 DeploymentConfigName *string `locationName:"deploymentConfigName" min:"1" type:"string"`
33603360
33613361 // The replacement set of Amazon EC2 tags to filter on, if you want to change
33623362 // them.
33633363 Ec2TagFilters []*EC2TagFilter `locationName:"ec2TagFilters" type:"list"`
33643364
33653365 // The new name of the deployment group, if you want to change it.
3366 NewDeploymentGroupName *string `locationName:"newDeploymentGroupName" type:"string"`
3366 NewDeploymentGroupName *string `locationName:"newDeploymentGroupName" min:"1" type:"string"`
33673367
33683368 // The replacement set of on-premises instance tags for filter on, if you want
33693369 // to change them.
+56
-56
service/codepipeline/api.go less more
758758 ClientToken *string `locationName:"clientToken" type:"string" required:"true"`
759759
760760 // The unique system-generated ID of the job.
761 JobId *string `locationName:"jobId" type:"string" required:"true"`
761 JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
762762
763763 // A system-generated random number that AWS CodePipeline uses to ensure that
764764 // the job is being worked on by only one job worker. This number must be returned
830830 type ActionConfigurationProperty struct {
831831 // The description of the action configuration property that will be displayed
832832 // to users.
833 Description *string `locationName:"description" type:"string"`
833 Description *string `locationName:"description" min:"1" type:"string"`
834834
835835 // Whether the configuration property is a key.
836836 Key *bool `locationName:"key" type:"boolean" required:"true"`
837837
838838 // The name of the action configuration property.
839 Name *string `locationName:"name" type:"string" required:"true"`
839 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
840840
841841 // Indicates that the proprety will be used in conjunction with PollForJobs.
842842 // When creating a custom action, an action can have up to one queryable property.
884884 // worker.
885885 type ActionContext struct {
886886 // The name of the action within the context of a job.
887 Name *string `locationName:"name" type:"string"`
887 Name *string `locationName:"name" min:"1" type:"string"`
888888
889889 metadataActionContext `json:"-" xml:"-"`
890890 }
916916 InputArtifacts []*InputArtifact `locationName:"inputArtifacts" type:"list"`
917917
918918 // The action declaration's name.
919 Name *string `locationName:"name" type:"string" required:"true"`
919 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
920920
921921 // The name or ID of the result of the action declaration, such as a test or
922922 // build artifact.
927927 RoleArn *string `locationName:"roleArn" type:"string"`
928928
929929 // The order in which actions are run.
930 RunOrder *int64 `locationName:"runOrder" type:"integer"`
930 RunOrder *int64 `locationName:"runOrder" min:"1" type:"integer"`
931931
932932 metadataActionDeclaration `json:"-" xml:"-"`
933933 }
956956
957957 // The URL of a resource external to AWS that will be used when running the
958958 // action, for example an external repository URL.
959 ExternalExecutionUrl *string `locationName:"externalExecutionUrl" type:"string"`
959 ExternalExecutionUrl *string `locationName:"externalExecutionUrl" min:"1" type:"string"`
960960
961961 // The last status change of the action.
962962 LastStatusChange *time.Time `locationName:"lastStatusChange" type:"timestamp" timestampFormat:"unix"`
10221022 // Represents information about the state of an action.
10231023 type ActionState struct {
10241024 // The name of the action.
1025 ActionName *string `locationName:"actionName" type:"string"`
1025 ActionName *string `locationName:"actionName" min:"1" type:"string"`
10261026
10271027 // Represents information about the version (or revision) of an action.
10281028 CurrentRevision *ActionRevision `locationName:"currentRevision" type:"structure"`
10291029
10301030 // A URL link for more information about the state of the action, such as a
10311031 // deployment group details page.
1032 EntityUrl *string `locationName:"entityUrl" type:"string"`
1032 EntityUrl *string `locationName:"entityUrl" min:"1" type:"string"`
10331033
10341034 // Represents information about how an action runs.
10351035 LatestExecution *ActionExecution `locationName:"latestExecution" type:"structure"`
10361036
10371037 // A URL link for more information about the revision, such as a commit details
10381038 // page.
1039 RevisionUrl *string `locationName:"revisionUrl" type:"string"`
1039 RevisionUrl *string `locationName:"revisionUrl" min:"1" type:"string"`
10401040
10411041 metadataActionState `json:"-" xml:"-"`
10421042 }
11031103 // determined by the action category. For example, an action in the Deploy category
11041104 // type might have a provider of AWS CodeDeploy, which would be specified as
11051105 // CodeDeploy.
1106 Provider *string `locationName:"provider" type:"string" required:"true"`
1106 Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`
11071107
11081108 // A string that identifies the action type.
1109 Version *string `locationName:"version" type:"string" required:"true"`
1109 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
11101110
11111111 metadataActionTypeId `json:"-" xml:"-"`
11121112 }
11311131 // to the resources of the external system, such as the configuration page for
11321132 // an AWS CodeDeploy deployment group. This link is provided as part of the
11331133 // action display within the pipeline.
1134 EntityUrlTemplate *string `locationName:"entityUrlTemplate" type:"string"`
1134 EntityUrlTemplate *string `locationName:"entityUrlTemplate" min:"1" type:"string"`
11351135
11361136 // The URL returned to the AWS CodePipeline console that contains a link to
11371137 // the top-level landing page for the external system, such as console page
11381138 // for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS
11391139 // CodePipeline console and provides a link to the execution entity of the external
11401140 // action.
1141 ExecutionUrlTemplate *string `locationName:"executionUrlTemplate" type:"string"`
1141 ExecutionUrlTemplate *string `locationName:"executionUrlTemplate" min:"1" type:"string"`
11421142
11431143 // The URL returned to the AWS CodePipeline console that contains a link to
11441144 // the page where customers can update or change the configuration of the external
11451145 // action.
1146 RevisionUrlTemplate *string `locationName:"revisionUrlTemplate" type:"string"`
1146 RevisionUrlTemplate *string `locationName:"revisionUrlTemplate" min:"1" type:"string"`
11471147
11481148 // The URL of a sign-up page where users can sign up for an external service
11491149 // and perform initial configuration of the action provided by that service.
1150 ThirdPartyConfigurationUrl *string `locationName:"thirdPartyConfigurationUrl" type:"string"`
1150 ThirdPartyConfigurationUrl *string `locationName:"thirdPartyConfigurationUrl" min:"1" type:"string"`
11511151
11521152 metadataActionTypeSettings `json:"-" xml:"-"`
11531153 }
11731173 Location *ArtifactLocation `locationName:"location" type:"structure"`
11741174
11751175 // The artifact's name.
1176 Name *string `locationName:"name" type:"string"`
1176 Name *string `locationName:"name" min:"1" type:"string"`
11771177
11781178 // The artifact's revision ID. Depending on the type of object, this could be
11791179 // a commit ID (GitHub) or a revision ID (Amazon S3).
12571257
12581258 // The location for storing the artifacts for a pipeline, such as an S3 bucket
12591259 // or folder.
1260 Location *string `locationName:"location" type:"string" required:"true"`
1260 Location *string `locationName:"location" min:"3" type:"string" required:"true"`
12611261
12621262 // The type of the artifact store, such as S3.
12631263 Type *string `locationName:"type" type:"string" required:"true" enum:"ArtifactStoreType"`
12821282 // Represents information about a gate declaration.
12831283 type BlockerDeclaration struct {
12841284 // The name of the gate declaration.
1285 Name *string `locationName:"name" type:"string" required:"true"`
1285 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
12861286
12871287 // The type of the gate declaration.
12881288 Type *string `locationName:"type" type:"string" required:"true" enum:"BlockerType"`
13191319 OutputArtifactDetails *ArtifactDetails `locationName:"outputArtifactDetails" type:"structure" required:"true"`
13201320
13211321 // The provider of the service used in the custom action, such as AWS CodeDeploy.
1322 Provider *string `locationName:"provider" type:"string" required:"true"`
1322 Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`
13231323
13241324 // Returns information about the settings for an action type.
13251325 Settings *ActionTypeSettings `locationName:"settings" type:"structure"`
13281328 //
13291329 // A newly-created custom action is always assigned a version number of 1.
13301330 // This is required.
1331 Version *string `locationName:"version" type:"string" required:"true"`
1331 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
13321332
13331333 metadataCreateCustomActionTypeInput `json:"-" xml:"-"`
13341334 }
14461446 Category *string `locationName:"category" type:"string" required:"true" enum:"ActionCategory"`
14471447
14481448 // The provider of the service used in the custom action, such as AWS CodeDeploy.
1449 Provider *string `locationName:"provider" type:"string" required:"true"`
1449 Provider *string `locationName:"provider" min:"1" type:"string" required:"true"`
14501450
14511451 // The version of the custom action to delete.
1452 Version *string `locationName:"version" type:"string" required:"true"`
1452 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
14531453
14541454 metadataDeleteCustomActionTypeInput `json:"-" xml:"-"`
14551455 }
14891489 // Represents the input of a delete pipeline action.
14901490 type DeletePipelineInput struct {
14911491 // The name of the pipeline to be deleted.
1492 Name *string `locationName:"name" type:"string" required:"true"`
1492 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
14931493
14941494 metadataDeletePipelineInput `json:"-" xml:"-"`
14951495 }
15301530 type DisableStageTransitionInput struct {
15311531 // The name of the pipeline in which you want to disable the flow of artifacts
15321532 // from one stage to another.
1533 PipelineName *string `locationName:"pipelineName" type:"string" required:"true"`
1533 PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`
15341534
15351535 // The reason given to the user why a stage is disabled, such as waiting for
15361536 // manual approval or manual tests. This message is displayed in the pipeline
15371537 // console UI.
1538 Reason *string `locationName:"reason" type:"string" required:"true"`
1538 Reason *string `locationName:"reason" min:"1" type:"string" required:"true"`
15391539
15401540 // The name of the stage where you want to disable the inbound or outbound transition
15411541 // of artifacts.
1542 StageName *string `locationName:"stageName" type:"string" required:"true"`
1542 StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`
15431543
15441544 // Specifies whether artifacts will be prevented from transitioning into the
15451545 // stage and being processed by the actions in that stage (inbound), or prevented
15861586 type EnableStageTransitionInput struct {
15871587 // The name of the pipeline in which you want to enable the flow of artifacts
15881588 // from one stage to another.
1589 PipelineName *string `locationName:"pipelineName" type:"string" required:"true"`
1589 PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`
15901590
15911591 // The name of the stage where you want to enable the transition of artifacts,
15921592 // either into the stage (inbound) or from that stage to the next stage (outbound).
1593 StageName *string `locationName:"stageName" type:"string" required:"true"`
1593 StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`
15941594
15951595 // Specifies whether artifacts will be allowed to enter the stage and be processed
15961596 // by the actions in that stage (inbound) or whether already-processed artifacts
16361636 // used to encrypt data in the artifact store.
16371637 type EncryptionKey struct {
16381638 // The ID of the AWS KMS key.
1639 Id *string `locationName:"id" type:"string" required:"true"`
1639 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
16401640
16411641 // The type of AWS KMS key, such as a customer master key.
16421642 Type *string `locationName:"type" type:"string" required:"true" enum:"EncryptionKeyType"`
17931793 type GetPipelineInput struct {
17941794 // The name of the pipeline for which you want to get information. Pipeline
17951795 // names must be unique under an Amazon Web Services (AWS) user account.
1796 Name *string `locationName:"name" type:"string" required:"true"`
1796 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
17971797
17981798 // The version number of the pipeline. If you do not specify a version, defaults
17991799 // to the most current version.
1800 Version *int64 `locationName:"version" type:"integer"`
1800 Version *int64 `locationName:"version" min:"1" type:"integer"`
18011801
18021802 metadataGetPipelineInput `json:"-" xml:"-"`
18031803 }
18411841 // Represents the input of a get pipeline state action.
18421842 type GetPipelineStateInput struct {
18431843 // The name of the pipeline about which you want to get information.
1844 Name *string `locationName:"name" type:"string" required:"true"`
1844 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
18451845
18461846 metadataGetPipelineStateInput `json:"-" xml:"-"`
18471847 }
18661866 Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix"`
18671867
18681868 // The name of the pipeline for which you want to get the state.
1869 PipelineName *string `locationName:"pipelineName" type:"string"`
1869 PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`
18701870
18711871 // The version number of the pipeline.
18721872 //
18731873 // A newly-created pipeline is always assigned a version number of 1.
1874 PipelineVersion *int64 `locationName:"pipelineVersion" type:"integer"`
1874 PipelineVersion *int64 `locationName:"pipelineVersion" min:"1" type:"integer"`
18751875
18761876 // A list of the pipeline stage output information, including stage name, state,
18771877 // most recent run details, whether the stage is disabled, and other data.
19041904 ClientToken *string `locationName:"clientToken" type:"string" required:"true"`
19051905
19061906 // The unique system-generated ID used for identifying the job.
1907 JobId *string `locationName:"jobId" type:"string" required:"true"`
1907 JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
19081908
19091909 metadataGetThirdPartyJobDetailsInput `json:"-" xml:"-"`
19101910 }
19551955 // action in strict sequence from the action that provided the output artifact.
19561956 // Actions in parallel can declare different output artifacts, which are in
19571957 // turn consumed by different following actions.
1958 Name *string `locationName:"name" type:"string" required:"true"`
1958 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
19591959
19601960 metadataInputArtifact `json:"-" xml:"-"`
19611961 }
21992199 // turn consumed by different following actions.
22002200 //
22012201 // Output artifact names must be unique within a pipeline.
2202 Name *string `locationName:"name" type:"string" required:"true"`
2202 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
22032203
22042204 metadataOutputArtifact `json:"-" xml:"-"`
22052205 }
22262226
22272227 // The name of the pipeline. This is a user-specified value. Pipeline names
22282228 // must be unique across all pipeline names under an Amazon Web Services account.
2229 PipelineName *string `locationName:"pipelineName" type:"string"`
2229 PipelineName *string `locationName:"pipelineName" min:"1" type:"string"`
22302230
22312231 // The stage of the pipeline.
22322232 Stage *StageContext `locationName:"stage" type:"structure"`
22562256 ArtifactStore *ArtifactStore `locationName:"artifactStore" type:"structure" required:"true"`
22572257
22582258 // The name of the action to be performed.
2259 Name *string `locationName:"name" type:"string" required:"true"`
2259 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
22602260
22612261 // The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform
22622262 // actions with no actionRoleArn, or to use to assume roles for actions with
22682268
22692269 // The version number of the pipeline. A new pipeline always has a version number
22702270 // of 1. This number is automatically incremented when a pipeline is updated.
2271 Version *int64 `locationName:"version" type:"integer"`
2271 Version *int64 `locationName:"version" min:"1" type:"integer"`
22722272
22732273 metadataPipelineDeclaration `json:"-" xml:"-"`
22742274 }
22932293 Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix"`
22942294
22952295 // The name of the pipeline.
2296 Name *string `locationName:"name" type:"string"`
2296 Name *string `locationName:"name" min:"1" type:"string"`
22972297
22982298 // The date and time of the last update to the pipeline, in timestamp format.
22992299 Updated *time.Time `locationName:"updated" type:"timestamp" timestampFormat:"unix"`
23002300
23012301 // The version number of the pipeline.
2302 Version *int64 `locationName:"version" type:"integer"`
2302 Version *int64 `locationName:"version" min:"1" type:"integer"`
23032303
23042304 metadataPipelineSummary `json:"-" xml:"-"`
23052305 }
23242324 ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"`
23252325
23262326 // The maximum number of jobs to return in a poll for jobs call.
2327 MaxBatchSize *int64 `locationName:"maxBatchSize" type:"integer"`
2327 MaxBatchSize *int64 `locationName:"maxBatchSize" min:"1" type:"integer"`
23282328
23292329 // A map of property names and values. For an action type with no queryable
23302330 // properties, this value must be null or an empty map. For an action type with
23772377 ActionTypeId *ActionTypeId `locationName:"actionTypeId" type:"structure" required:"true"`
23782378
23792379 // The maximum number of jobs to return in a poll for jobs call.
2380 MaxBatchSize *int64 `locationName:"maxBatchSize" type:"integer"`
2380 MaxBatchSize *int64 `locationName:"maxBatchSize" min:"1" type:"integer"`
23812381
23822382 metadataPollForThirdPartyJobsInput `json:"-" xml:"-"`
23832383 }
24212421 // Represents the input of a put action revision action.
24222422 type PutActionRevisionInput struct {
24232423 // The name of the action that will process the revision.
2424 ActionName *string `locationName:"actionName" type:"string" required:"true"`
2424 ActionName *string `locationName:"actionName" min:"1" type:"string" required:"true"`
24252425
24262426 // Represents information about the version (or revision) of an action.
24272427 ActionRevision *ActionRevision `locationName:"actionRevision" type:"structure" required:"true"`
24282428
24292429 // The name of the pipeline that will start processing the revision to the source.
2430 PipelineName *string `locationName:"pipelineName" type:"string" required:"true"`
2430 PipelineName *string `locationName:"pipelineName" min:"1" type:"string" required:"true"`
24312431
24322432 // The name of the stage that contains the action that will act upon the revision.
2433 StageName *string `locationName:"stageName" type:"string" required:"true"`
2433 StageName *string `locationName:"stageName" min:"1" type:"string" required:"true"`
24342434
24352435 metadataPutActionRevisionInput `json:"-" xml:"-"`
24362436 }
25812581 FailureDetails *FailureDetails `locationName:"failureDetails" type:"structure" required:"true"`
25822582
25832583 // The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
2584 JobId *string `locationName:"jobId" type:"string" required:"true"`
2584 JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
25852585
25862586 metadataPutThirdPartyJobFailureResultInput `json:"-" xml:"-"`
25872587 }
26372637
26382638 // The ID of the job that successfully completed. This is the same ID returned
26392639 // from PollForThirdPartyJobs.
2640 JobId *string `locationName:"jobId" type:"string" required:"true"`
2640 JobId *string `locationName:"jobId" min:"1" type:"string" required:"true"`
26412641
26422642 metadataPutThirdPartyJobSuccessResultInput `json:"-" xml:"-"`
26432643 }
27032703 // Represents information about a stage to a job worker.
27042704 type StageContext struct {
27052705 // The name of the stage.
2706 Name *string `locationName:"name" type:"string"`
2706 Name *string `locationName:"name" min:"1" type:"string"`
27072707
27082708 metadataStageContext `json:"-" xml:"-"`
27092709 }
27312731 Blockers []*BlockerDeclaration `locationName:"blockers" type:"list"`
27322732
27332733 // The name of the stage.
2734 Name *string `locationName:"name" type:"string" required:"true"`
2734 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
27352735
27362736 metadataStageDeclaration `json:"-" xml:"-"`
27372737 }
27592759 InboundTransitionState *TransitionState `locationName:"inboundTransitionState" type:"structure"`
27602760
27612761 // The name of the stage.
2762 StageName *string `locationName:"stageName" type:"string"`
2762 StageName *string `locationName:"stageName" min:"1" type:"string"`
27632763
27642764 metadataStageState `json:"-" xml:"-"`
27652765 }
27812781 // Represents the input of a start pipeline execution action.
27822782 type StartPipelineExecutionInput struct {
27832783 // The name of the pipeline to start.
2784 Name *string `locationName:"name" type:"string" required:"true"`
2784 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
27852785
27862786 metadataStartPipelineExecutionInput `json:"-" xml:"-"`
27872787 }
29092909 Data *ThirdPartyJobData `locationName:"data" type:"structure"`
29102910
29112911 // The identifier used to identify the job details in AWS CodePipeline.
2912 Id *string `locationName:"id" type:"string"`
2912 Id *string `locationName:"id" min:"1" type:"string"`
29132913
29142914 // A system-generated random number that AWS CodePipeline uses to ensure that
29152915 // the job is being worked on by only one job worker. This number must be returned
29382938 type TransitionState struct {
29392939 // The user-specified reason why the transition between two stages of a pipeline
29402940 // was disabled.
2941 DisabledReason *string `locationName:"disabledReason" type:"string"`
2941 DisabledReason *string `locationName:"disabledReason" min:"1" type:"string"`
29422942
29432943 // Whether the transition between stages is enabled (true) or disabled (false).
29442944 Enabled *bool `locationName:"enabled" type:"boolean"`
+52
-52
service/cognitoidentity/api.go less more
589589 //
590590 // Once you have set a developer provider name, you cannot change it. Please
591591 // take care in setting this parameter.
592 DeveloperProviderName *string `type:"string"`
592 DeveloperProviderName *string `min:"1" type:"string"`
593593
594594 // A string that you provide.
595 IdentityPoolName *string `type:"string" required:"true"`
595 IdentityPoolName *string `min:"1" type:"string" required:"true"`
596596
597597 // A list of OpendID Connect provider ARNs.
598598 OpenIdConnectProviderARNs []*string `type:"list"`
651651 // Input to the DeleteIdentities action.
652652 type DeleteIdentitiesInput struct {
653653 // A list of 1-60 identities that you want to delete.
654 IdentityIdsToDelete []*string `type:"list" required:"true"`
654 IdentityIdsToDelete []*string `min:"1" type:"list" required:"true"`
655655
656656 metadataDeleteIdentitiesInput `json:"-" xml:"-"`
657657 }
696696 // Input to the DeleteIdentityPool action.
697697 type DeleteIdentityPoolInput struct {
698698 // An identity pool ID in the format REGION:GUID.
699 IdentityPoolId *string `type:"string" required:"true"`
699 IdentityPoolId *string `min:"1" type:"string" required:"true"`
700700
701701 metadataDeleteIdentityPoolInput `json:"-" xml:"-"`
702702 }
736736 // Input to the DescribeIdentity action.
737737 type DescribeIdentityInput struct {
738738 // A unique identifier in the format REGION:GUID.
739 IdentityId *string `type:"string" required:"true"`
739 IdentityId *string `min:"1" type:"string" required:"true"`
740740
741741 metadataDescribeIdentityInput `json:"-" xml:"-"`
742742 }
758758 // Input to the DescribeIdentityPool action.
759759 type DescribeIdentityPoolInput struct {
760760 // An identity pool ID in the format REGION:GUID.
761 IdentityPoolId *string `type:"string" required:"true"`
761 IdentityPoolId *string `min:"1" type:"string" required:"true"`
762762
763763 metadataDescribeIdentityPoolInput `json:"-" xml:"-"`
764764 }
780780 // Input to the GetCredentialsForIdentity action.
781781 type GetCredentialsForIdentityInput struct {
782782 // A unique identifier in the format REGION:GUID.
783 IdentityId *string `type:"string" required:"true"`
783 IdentityId *string `min:"1" type:"string" required:"true"`
784784
785785 // A set of optional name-value pairs that map provider names to provider tokens.
786786 Logins map[string]*string `type:"map"`
808808 Credentials *Credentials `type:"structure"`
809809
810810 // A unique identifier in the format REGION:GUID.
811 IdentityId *string `type:"string"`
811 IdentityId *string `min:"1" type:"string"`
812812
813813 metadataGetCredentialsForIdentityOutput `json:"-" xml:"-"`
814814 }
830830 // Input to the GetId action.
831831 type GetIdInput struct {
832832 // A standard AWS account ID (9+ digits).
833 AccountId *string `type:"string"`
833 AccountId *string `min:"1" type:"string"`
834834
835835 // An identity pool ID in the format REGION:GUID.
836 IdentityPoolId *string `type:"string" required:"true"`
836 IdentityPoolId *string `min:"1" type:"string" required:"true"`
837837
838838 // A set of optional name-value pairs that map provider names to provider tokens.
839839 //
862862 // Returned in response to a GetId request.
863863 type GetIdOutput struct {
864864 // A unique identifier in the format REGION:GUID.
865 IdentityId *string `type:"string"`
865 IdentityId *string `min:"1" type:"string"`
866866
867867 metadataGetIdOutput `json:"-" xml:"-"`
868868 }
884884 // Input to the GetIdentityPoolRoles action.
885885 type GetIdentityPoolRolesInput struct {
886886 // An identity pool ID in the format REGION:GUID.
887 IdentityPoolId *string `type:"string" required:"true"`
887 IdentityPoolId *string `min:"1" type:"string" required:"true"`
888888
889889 metadataGetIdentityPoolRolesInput `json:"-" xml:"-"`
890890 }
906906 // Returned in response to a successful GetIdentityPoolRoles operation.
907907 type GetIdentityPoolRolesOutput struct {
908908 // An identity pool ID in the format REGION:GUID.
909 IdentityPoolId *string `type:"string"`
909 IdentityPoolId *string `min:"1" type:"string"`
910910
911911 // The map of roles associated with this pool. Currently only authenticated
912912 // and unauthenticated roles are supported.
932932 // Input to the GetOpenIdTokenForDeveloperIdentity action.
933933 type GetOpenIdTokenForDeveloperIdentityInput struct {
934934 // A unique identifier in the format REGION:GUID.
935 IdentityId *string `type:"string"`
935 IdentityId *string `min:"1" type:"string"`
936936
937937 // An identity pool ID in the format REGION:GUID.
938 IdentityPoolId *string `type:"string" required:"true"`
938 IdentityPoolId *string `min:"1" type:"string" required:"true"`
939939
940940 // A set of optional name-value pairs that map provider names to provider tokens.
941941 // Each name-value pair represents a user from a public provider or developer
956956 // take care in setting the expiration time for a token, as there are significant
957957 // security implications: an attacker could use a leaked token to access your
958958 // AWS resources for the token's duration.
959 TokenDuration *int64 `type:"long"`
959 TokenDuration *int64 `min:"1" type:"long"`
960960
961961 metadataGetOpenIdTokenForDeveloperIdentityInput `json:"-" xml:"-"`
962962 }
978978 // Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.
979979 type GetOpenIdTokenForDeveloperIdentityOutput struct {
980980 // A unique identifier in the format REGION:GUID.
981 IdentityId *string `type:"string"`
981 IdentityId *string `min:"1" type:"string"`
982982
983983 // An OpenID token.
984984 Token *string `type:"string"`
10031003 // Input to the GetOpenIdToken action.
10041004 type GetOpenIdTokenInput struct {
10051005 // A unique identifier in the format REGION:GUID.
1006 IdentityId *string `type:"string" required:"true"`
1006 IdentityId *string `min:"1" type:"string" required:"true"`
10071007
10081008 // A set of optional name-value pairs that map provider names to provider tokens.
10091009 // When using graph.facebook.com and www.amazon.com, supply the access_token
10321032 type GetOpenIdTokenOutput struct {
10331033 // A unique identifier in the format REGION:GUID. Note that the IdentityId returned
10341034 // may not match the one passed on input.
1035 IdentityId *string `type:"string"`
1035 IdentityId *string `min:"1" type:"string"`
10361036
10371037 // An OpenID token, valid for 15 minutes.
10381038 Token *string `type:"string"`
10601060 CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"`
10611061
10621062 // A unique identifier in the format REGION:GUID.
1063 IdentityId *string `type:"string"`
1063 IdentityId *string `min:"1" type:"string"`
10641064
10651065 // Date on which the identity was last modified.
10661066 LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
10911091 AllowUnauthenticatedIdentities *bool `type:"boolean" required:"true"`
10921092
10931093 // The "domain" by which Cognito will refer to your users.
1094 DeveloperProviderName *string `type:"string"`
1094 DeveloperProviderName *string `min:"1" type:"string"`
10951095
10961096 // An identity pool ID in the format REGION:GUID.
1097 IdentityPoolId *string `type:"string" required:"true"`
1097 IdentityPoolId *string `min:"1" type:"string" required:"true"`
10981098
10991099 // A string that you provide.
1100 IdentityPoolName *string `type:"string" required:"true"`
1100 IdentityPoolName *string `min:"1" type:"string" required:"true"`
11011101
11021102 // A list of OpendID Connect provider ARNs.
11031103 OpenIdConnectProviderARNs []*string `type:"list"`
11251125 // A description of the identity pool.
11261126 type IdentityPoolShortDescription struct {
11271127 // An identity pool ID in the format REGION:GUID.
1128 IdentityPoolId *string `type:"string"`
1128 IdentityPoolId *string `min:"1" type:"string"`
11291129
11301130 // A string that you provide.
1131 IdentityPoolName *string `type:"string"`
1131 IdentityPoolName *string `min:"1" type:"string"`
11321132
11331133 metadataIdentityPoolShortDescription `json:"-" xml:"-"`
11341134 }
11551155 HideDisabled *bool `type:"boolean"`
11561156
11571157 // An identity pool ID in the format REGION:GUID.
1158 IdentityPoolId *string `type:"string" required:"true"`
1158 IdentityPoolId *string `min:"1" type:"string" required:"true"`
11591159
11601160 // The maximum number of identities to return.
1161 MaxResults *int64 `type:"integer" required:"true"`
1161 MaxResults *int64 `min:"1" type:"integer" required:"true"`
11621162
11631163 // A pagination token.
1164 NextToken *string `type:"string"`
1164 NextToken *string `min:"1" type:"string"`
11651165
11661166 metadataListIdentitiesInput `json:"-" xml:"-"`
11671167 }
11861186 Identities []*IdentityDescription `type:"list"`
11871187
11881188 // An identity pool ID in the format REGION:GUID.
1189 IdentityPoolId *string `type:"string"`
1189 IdentityPoolId *string `min:"1" type:"string"`
11901190
11911191 // A pagination token.
1192 NextToken *string `type:"string"`
1192 NextToken *string `min:"1" type:"string"`
11931193
11941194 metadataListIdentitiesOutput `json:"-" xml:"-"`
11951195 }
12111211 // Input to the ListIdentityPools action.
12121212 type ListIdentityPoolsInput struct {
12131213 // The maximum number of identities to return.
1214 MaxResults *int64 `type:"integer" required:"true"`
1214 MaxResults *int64 `min:"1" type:"integer" required:"true"`
12151215
12161216 // A pagination token.
1217 NextToken *string `type:"string"`
1217 NextToken *string `min:"1" type:"string"`
12181218
12191219 metadataListIdentityPoolsInput `json:"-" xml:"-"`
12201220 }
12391239 IdentityPools []*IdentityPoolShortDescription `type:"list"`
12401240
12411241 // A pagination token.
1242 NextToken *string `type:"string"`
1242 NextToken *string `min:"1" type:"string"`
12431243
12441244 metadataListIdentityPoolsOutput `json:"-" xml:"-"`
12451245 }
12631263 // A unique ID used by your backend authentication process to identify a user.
12641264 // Typically, a developer identity provider would issue many developer user
12651265 // identifiers, in keeping with the number of users.
1266 DeveloperUserIdentifier *string `type:"string"`
1266 DeveloperUserIdentifier *string `min:"1" type:"string"`
12671267
12681268 // A unique identifier in the format REGION:GUID.
1269 IdentityId *string `type:"string"`
1269 IdentityId *string `min:"1" type:"string"`
12701270
12711271 // An identity pool ID in the format REGION:GUID.
1272 IdentityPoolId *string `type:"string" required:"true"`
1272 IdentityPoolId *string `min:"1" type:"string" required:"true"`
12731273
12741274 // The maximum number of identities to return.
1275 MaxResults *int64 `type:"integer"`
1275 MaxResults *int64 `min:"1" type:"integer"`
12761276
12771277 // A pagination token. The first call you make will have NextToken set to null.
12781278 // After that the service will return NextToken values as needed. For example,
12801280 // matches in the database. The service will return a pagination token as a
12811281 // part of the response. This token can be used to call the API again and get
12821282 // results starting from the 11th match.
1283 NextToken *string `type:"string"`
1283 NextToken *string `min:"1" type:"string"`
12841284
12851285 metadataLookupDeveloperIdentityInput `json:"-" xml:"-"`
12861286 }
13071307 DeveloperUserIdentifierList []*string `type:"list"`
13081308
13091309 // A unique identifier in the format REGION:GUID.
1310 IdentityId *string `type:"string"`
1310 IdentityId *string `min:"1" type:"string"`
13111311
13121312 // A pagination token. The first call you make will have NextToken set to null.
13131313 // After that the service will return NextToken values as needed. For example,
13151315 // matches in the database. The service will return a pagination token as a
13161316 // part of the response. This token can be used to call the API again and get
13171317 // results starting from the 11th match.
1318 NextToken *string `type:"string"`
1318 NextToken *string `min:"1" type:"string"`
13191319
13201320 metadataLookupDeveloperIdentityOutput `json:"-" xml:"-"`
13211321 }
13371337 // Input to the MergeDeveloperIdentities action.
13381338 type MergeDeveloperIdentitiesInput struct {
13391339 // User identifier for the destination user. The value should be a DeveloperUserIdentifier.
1340 DestinationUserIdentifier *string `type:"string" required:"true"`
1340 DestinationUserIdentifier *string `min:"1" type:"string" required:"true"`
13411341
13421342 // The "domain" by which Cognito will refer to your users. This is a (pseudo)
13431343 // domain name that you provide while creating an identity pool. This name acts
13441344 // as a placeholder that allows your backend and the Cognito service to communicate
13451345 // about the developer provider. For the DeveloperProviderName, you can use
13461346 // letters as well as period (.), underscore (_), and dash (-).
1347 DeveloperProviderName *string `type:"string" required:"true"`
1347 DeveloperProviderName *string `min:"1" type:"string" required:"true"`
13481348
13491349 // An identity pool ID in the format REGION:GUID.
1350 IdentityPoolId *string `type:"string" required:"true"`
1350 IdentityPoolId *string `min:"1" type:"string" required:"true"`
13511351
13521352 // User identifier for the source user. The value should be a DeveloperUserIdentifier.
1353 SourceUserIdentifier *string `type:"string" required:"true"`
1353 SourceUserIdentifier *string `min:"1" type:"string" required:"true"`
13541354
13551355 metadataMergeDeveloperIdentitiesInput `json:"-" xml:"-"`
13561356 }
13721372 // Returned in response to a successful MergeDeveloperIdentities action.
13731373 type MergeDeveloperIdentitiesOutput struct {
13741374 // A unique identifier in the format REGION:GUID.
1375 IdentityId *string `type:"string"`
1375 IdentityId *string `min:"1" type:"string"`
13761376
13771377 metadataMergeDeveloperIdentitiesOutput `json:"-" xml:"-"`
13781378 }
13941394 // Input to the SetIdentityPoolRoles action.
13951395 type SetIdentityPoolRolesInput struct {
13961396 // An identity pool ID in the format REGION:GUID.
1397 IdentityPoolId *string `type:"string" required:"true"`
1397 IdentityPoolId *string `min:"1" type:"string" required:"true"`
13981398
13991399 // The map of roles associated with this pool. For a given role, the key will
14001400 // be either "authenticated" or "unauthenticated" and the value will be the
14391439 // Input to the UnlinkDeveloperIdentity action.
14401440 type UnlinkDeveloperIdentityInput struct {
14411441 // The "domain" by which Cognito will refer to your users.
1442 DeveloperProviderName *string `type:"string" required:"true"`
1442 DeveloperProviderName *string `min:"1" type:"string" required:"true"`
14431443
14441444 // A unique ID used by your backend authentication process to identify a user.
1445 DeveloperUserIdentifier *string `type:"string" required:"true"`
1445 DeveloperUserIdentifier *string `min:"1" type:"string" required:"true"`
14461446
14471447 // A unique identifier in the format REGION:GUID.
1448 IdentityId *string `type:"string" required:"true"`
1448 IdentityId *string `min:"1" type:"string" required:"true"`
14491449
14501450 // An identity pool ID in the format REGION:GUID.
1451 IdentityPoolId *string `type:"string" required:"true"`
1451 IdentityPoolId *string `min:"1" type:"string" required:"true"`
14521452
14531453 metadataUnlinkDeveloperIdentityInput `json:"-" xml:"-"`
14541454 }
14881488 // Input to the UnlinkIdentity action.
14891489 type UnlinkIdentityInput struct {
14901490 // A unique identifier in the format REGION:GUID.
1491 IdentityId *string `type:"string" required:"true"`
1491 IdentityId *string `min:"1" type:"string" required:"true"`
14921492
14931493 // A set of optional name-value pairs that map provider names to provider tokens.
14941494 Logins map[string]*string `type:"map" required:"true"`
15381538 ErrorCode *string `type:"string" enum:"ErrorCode"`
15391539
15401540 // A unique identifier in the format REGION:GUID.
1541 IdentityId *string `type:"string"`
1541 IdentityId *string `min:"1" type:"string"`
15421542
15431543 metadataUnprocessedIdentityId `json:"-" xml:"-"`
15441544 }
+85
-85
service/cognitosync/api.go less more
560560 type BulkPublishInput struct {
561561 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
562562 // created by Amazon Cognito. GUID generation is unique within a region.
563 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
563 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
564564
565565 metadataBulkPublishInput `json:"-" xml:"-"`
566566 }
583583 type BulkPublishOutput struct {
584584 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
585585 // created by Amazon Cognito. GUID generation is unique within a region.
586 IdentityPoolId *string `type:"string"`
586 IdentityPoolId *string `min:"1" type:"string"`
587587
588588 metadataBulkPublishOutput `json:"-" xml:"-"`
589589 }
607607 // The ARN of the role Amazon Cognito can assume in order to publish to the
608608 // stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke
609609 // PutRecord on your Cognito stream.
610 RoleArn *string `type:"string"`
610 RoleArn *string `min:"20" type:"string"`
611611
612612 // The name of the Cognito stream to receive updates. This stream must be in
613613 // the developers account and in the same region as the identity pool.
614 StreamName *string `type:"string"`
614 StreamName *string `min:"1" type:"string"`
615615
616616 // Status of the Cognito streams. Valid values are: ENABLED - Streaming of updates
617617 // to identity pool is enabled.
651651
652652 // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
653653 // (underscore), '-' (dash), and '.' (dot).
654 DatasetName *string `type:"string"`
655
656 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
657 // created by Amazon Cognito. GUID generation is unique within a region.
658 IdentityId *string `type:"string"`
654 DatasetName *string `min:"1" type:"string"`
655
656 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
657 // created by Amazon Cognito. GUID generation is unique within a region.
658 IdentityId *string `min:"1" type:"string"`
659659
660660 // The device that made the last change to this dataset.
661661 LastModifiedBy *string `type:"string"`
687687 type DeleteDatasetInput struct {
688688 // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
689689 // (underscore), '-' (dash), and '.' (dot).
690 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
691
692 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
693 // created by Amazon Cognito. GUID generation is unique within a region.
694 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
695
696 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
697 // created by Amazon Cognito. GUID generation is unique within a region.
698 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
690 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
691
692 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
693 // created by Amazon Cognito. GUID generation is unique within a region.
694 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
695
696 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
697 // created by Amazon Cognito. GUID generation is unique within a region.
698 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
699699
700700 metadataDeleteDatasetInput `json:"-" xml:"-"`
701701 }
745745 type DescribeDatasetInput struct {
746746 // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
747747 // (underscore), '-' (dash), and '.' (dot).
748 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
749
750 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
751 // created by Amazon Cognito. GUID generation is unique within a region.
752 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
753
754 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
755 // created by Amazon Cognito. GUID generation is unique within a region.
756 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
748 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
749
750 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
751 // created by Amazon Cognito. GUID generation is unique within a region.
752 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
753
754 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
755 // created by Amazon Cognito. GUID generation is unique within a region.
756 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
757757
758758 metadataDescribeDatasetInput `json:"-" xml:"-"`
759759 }
802802 type DescribeIdentityPoolUsageInput struct {
803803 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
804804 // created by Amazon Cognito. GUID generation is unique within a region.
805 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
805 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
806806
807807 metadataDescribeIdentityPoolUsageInput `json:"-" xml:"-"`
808808 }
847847 type DescribeIdentityUsageInput struct {
848848 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
849849 // created by Amazon Cognito. GUID generation is unique within a region.
850 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
851
852 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
853 // created by Amazon Cognito. GUID generation is unique within a region.
854 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
850 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
851
852 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
853 // created by Amazon Cognito. GUID generation is unique within a region.
854 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
855855
856856 metadataDescribeIdentityUsageInput `json:"-" xml:"-"`
857857 }
896896 type GetBulkPublishDetailsInput struct {
897897 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
898898 // created by Amazon Cognito. GUID generation is unique within a region.
899 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
899 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
900900
901901 metadataGetBulkPublishDetailsInput `json:"-" xml:"-"`
902902 }
942942
943943 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
944944 // created by Amazon Cognito. GUID generation is unique within a region.
945 IdentityPoolId *string `type:"string"`
945 IdentityPoolId *string `min:"1" type:"string"`
946946
947947 metadataGetBulkPublishDetailsOutput `json:"-" xml:"-"`
948948 }
964964 // A request for a list of the configured Cognito Events
965965 type GetCognitoEventsInput struct {
966966 // The Cognito Identity Pool ID for the request
967 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
967 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
968968
969969 metadataGetCognitoEventsInput `json:"-" xml:"-"`
970970 }
10101010 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
10111011 // created by Amazon Cognito. This is the ID of the pool for which to return
10121012 // a configuration.
1013 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1013 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
10141014
10151015 metadataGetIdentityPoolConfigurationInput `json:"-" xml:"-"`
10161016 }
10361036
10371037 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
10381038 // created by Amazon Cognito.
1039 IdentityPoolId *string `type:"string"`
1039 IdentityPoolId *string `min:"1" type:"string"`
10401040
10411041 // Options to apply to this identity pool for push synchronization.
10421042 PushSync *PushSync `type:"structure"`
10651065
10661066 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
10671067 // created by Amazon Cognito. GUID generation is unique within a region.
1068 IdentityPoolId *string `type:"string"`
1068 IdentityPoolId *string `min:"1" type:"string"`
10691069
10701070 // Date on which the identity pool was last modified.
10711071 LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
11001100
11011101 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
11021102 // created by Amazon Cognito. GUID generation is unique within a region.
1103 IdentityId *string `type:"string"`
1104
1105 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1106 // created by Amazon Cognito. GUID generation is unique within a region.
1107 IdentityPoolId *string `type:"string"`
1103 IdentityId *string `min:"1" type:"string"`
1104
1105 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1106 // created by Amazon Cognito. GUID generation is unique within a region.
1107 IdentityPoolId *string `min:"1" type:"string"`
11081108
11091109 // Date on which the identity was last modified.
11101110 LastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
11301130 type ListDatasetsInput struct {
11311131 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
11321132 // created by Amazon Cognito. GUID generation is unique within a region.
1133 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1134
1135 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1136 // created by Amazon Cognito. GUID generation is unique within a region.
1137 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1133 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
1134
1135 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1136 // created by Amazon Cognito. GUID generation is unique within a region.
1137 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
11381138
11391139 // The maximum number of results to be returned.
11401140 MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"`
12471247 type ListRecordsInput struct {
12481248 // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
12491249 // (underscore), '-' (dash), and '.' (dot).
1250 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
1251
1252 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1253 // created by Amazon Cognito. GUID generation is unique within a region.
1254 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1255
1256 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1257 // created by Amazon Cognito. GUID generation is unique within a region.
1258 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1250 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
1251
1252 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1253 // created by Amazon Cognito. GUID generation is unique within a region.
1254 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
1255
1256 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1257 // created by Amazon Cognito. GUID generation is unique within a region.
1258 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
12591259
12601260 // The last server sync count for this record.
12611261 LastSyncCount *int64 `location:"querystring" locationName:"lastSyncCount" type:"long"`
13381338 ApplicationArns []*string `type:"list"`
13391339
13401340 // A role configured to allow Cognito to call SNS on behalf of the developer.
1341 RoleArn *string `type:"string"`
1341 RoleArn *string `min:"20" type:"string"`
13421342
13431343 metadataPushSync `json:"-" xml:"-"`
13441344 }
13631363 DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
13641364
13651365 // The key for the record.
1366 Key *string `type:"string"`
1366 Key *string `min:"1" type:"string"`
13671367
13681368 // The user/device that made the last change to this record.
13691369 LastModifiedBy *string `type:"string"`
14001400 DeviceLastModifiedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
14011401
14021402 // The key associated with the record patch.
1403 Key *string `type:"string" required:"true"`
1403 Key *string `min:"1" type:"string" required:"true"`
14041404
14051405 // An operation, either replace or remove.
14061406 Op *string `type:"string" required:"true" enum:"Operation"`
14311431 // A request to RegisterDevice.
14321432 type RegisterDeviceInput struct {
14331433 // The unique ID for this identity.
1434 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1434 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
14351435
14361436 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
14371437 // created by Amazon Cognito. Here, the ID of the pool that the identity belongs
14381438 // to.
1439 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1439 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
14401440
14411441 // The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
14421442 Platform *string `type:"string" required:"true" enum:"Platform"`
14641464 // Response to a RegisterDevice request.
14651465 type RegisterDeviceOutput struct {
14661466 // The unique ID generated for this device by Cognito.
1467 DeviceId *string `type:"string"`
1467 DeviceId *string `min:"1" type:"string"`
14681468
14691469 metadataRegisterDeviceOutput `json:"-" xml:"-"`
14701470 }
14911491 Events map[string]*string `type:"map" required:"true"`
14921492
14931493 // The Cognito Identity Pool to use when configuring Cognito Events
1494 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1494 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
14951495
14961496 metadataSetCognitoEventsInput `json:"-" xml:"-"`
14971497 }
15351535
15361536 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
15371537 // created by Amazon Cognito. This is the ID of the pool to modify.
1538 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1538 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
15391539
15401540 // Options to apply to this identity pool for push synchronization.
15411541 PushSync *PushSync `type:"structure"`
15641564
15651565 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
15661566 // created by Amazon Cognito.
1567 IdentityPoolId *string `type:"string"`
1567 IdentityPoolId *string `min:"1" type:"string"`
15681568
15691569 // Options to apply to this identity pool for push synchronization.
15701570 PushSync *PushSync `type:"structure"`
15891589 // A request to SubscribeToDatasetRequest.
15901590 type SubscribeToDatasetInput struct {
15911591 // The name of the dataset to subcribe to.
1592 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
1592 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
15931593
15941594 // The unique ID generated for this device by Cognito.
1595 DeviceId *string `location:"uri" locationName:"DeviceId" type:"string" required:"true"`
1595 DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`
15961596
15971597 // Unique ID for this identity.
1598 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1598 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
15991599
16001600 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
16011601 // created by Amazon Cognito. The ID of the pool to which the identity belongs.
1602 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1602 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
16031603
16041604 metadataSubscribeToDatasetInput `json:"-" xml:"-"`
16051605 }
16401640 // A request to UnsubscribeFromDataset.
16411641 type UnsubscribeFromDatasetInput struct {
16421642 // The name of the dataset from which to unsubcribe.
1643 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
1643 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
16441644
16451645 // The unique ID generated for this device by Cognito.
1646 DeviceId *string `location:"uri" locationName:"DeviceId" type:"string" required:"true"`
1646 DeviceId *string `location:"uri" locationName:"DeviceId" min:"1" type:"string" required:"true"`
16471647
16481648 // Unique ID for this identity.
1649 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1649 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
16501650
16511651 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
16521652 // created by Amazon Cognito. The ID of the pool to which this identity belongs.
1653 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1653 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
16541654
16551655 metadataUnsubscribeFromDatasetInput `json:"-" xml:"-"`
16561656 }
16971697
16981698 // A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_'
16991699 // (underscore), '-' (dash), and '.' (dot).
1700 DatasetName *string `location:"uri" locationName:"DatasetName" type:"string" required:"true"`
1700 DatasetName *string `location:"uri" locationName:"DatasetName" min:"1" type:"string" required:"true"`
17011701
17021702 // The unique ID generated for this device by Cognito.
1703 DeviceId *string `type:"string"`
1704
1705 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1706 // created by Amazon Cognito. GUID generation is unique within a region.
1707 IdentityId *string `location:"uri" locationName:"IdentityId" type:"string" required:"true"`
1708
1709 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1710 // created by Amazon Cognito. GUID generation is unique within a region.
1711 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" type:"string" required:"true"`
1703 DeviceId *string `min:"1" type:"string"`
1704
1705 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1706 // created by Amazon Cognito. GUID generation is unique within a region.
1707 IdentityId *string `location:"uri" locationName:"IdentityId" min:"1" type:"string" required:"true"`
1708
1709 // A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE)
1710 // created by Amazon Cognito. GUID generation is unique within a region.
1711 IdentityPoolId *string `location:"uri" locationName:"IdentityPoolId" min:"1" type:"string" required:"true"`
17121712
17131713 // A list of patch operations.
17141714 RecordPatches []*RecordPatch `type:"list"`
+6
-6
service/configservice/api.go less more
582582 // The name of the recorder. By default, AWS Config automatically assigns the
583583 // name "default" when creating the configuration recorder. You cannot change
584584 // the assigned name.
585 Name *string `locationName:"name" type:"string"`
585 Name *string `locationName:"name" min:"1" type:"string"`
586586
587587 // The recording group specifies either to record configurations for all supported
588588 // resources or to provide a list of resource types to record. The list of resource
657657 // data in JSON format.
658658 type DeleteDeliveryChannelInput struct {
659659 // The name of the delivery channel to delete.
660 DeliveryChannelName *string `type:"string" required:"true"`
660 DeliveryChannelName *string `min:"1" type:"string" required:"true"`
661661
662662 metadataDeleteDeliveryChannelInput `json:"-" xml:"-"`
663663 }
697697 // The input for the DeliverConfigSnapshot action.
698698 type DeliverConfigSnapshotInput struct {
699699 // The name of the delivery channel through which the snapshot is delivered.
700 DeliveryChannelName *string `locationName:"deliveryChannelName" type:"string" required:"true"`
700 DeliveryChannelName *string `locationName:"deliveryChannelName" min:"1" type:"string" required:"true"`
701701
702702 metadataDeliverConfigSnapshotInput `json:"-" xml:"-"`
703703 }
744744 // The name of the delivery channel. By default, AWS Config automatically assigns
745745 // the name "default" when creating the delivery channel. You cannot change
746746 // the assigned name.
747 Name *string `locationName:"name" type:"string"`
747 Name *string `locationName:"name" min:"1" type:"string"`
748748
749749 // The name of the Amazon S3 bucket used to store configuration history for
750750 // the delivery channel.
13151315 type StartConfigurationRecorderInput struct {
13161316 // The name of the recorder object that records each configuration change made
13171317 // to the resources.
1318 ConfigurationRecorderName *string `type:"string" required:"true"`
1318 ConfigurationRecorderName *string `min:"1" type:"string" required:"true"`
13191319
13201320 metadataStartConfigurationRecorderInput `json:"-" xml:"-"`
13211321 }
13561356 type StopConfigurationRecorderInput struct {
13571357 // The name of the recorder object that records each configuration change made
13581358 // to the resources.
1359 ConfigurationRecorderName *string `type:"string" required:"true"`
1359 ConfigurationRecorderName *string `min:"1" type:"string" required:"true"`
13601360
13611361 metadataStopConfigurationRecorderInput `json:"-" xml:"-"`
13621362 }
+38
-38
service/datapipeline/api.go less more
650650 ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
651651
652652 // The ID of the pipeline.
653 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
653 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
654654
655655 // The date and time to resume the pipeline. By default, the pipeline resumes
656656 // from the last completed execution.
695695 // Contains the parameters for AddTags.
696696 type AddTagsInput struct {
697697 // The ID of the pipeline.
698 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
698 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
699699
700700 // The tags to add, as key/value pairs.
701701 Tags []*Tag `locationName:"tags" type:"list" required:"true"`
744744 // The name for the pipeline. You can use the same name for multiple pipelines
745745 // associated with your AWS account, because AWS Data Pipeline assigns each
746746 // pipeline a unique pipeline identifier.
747 Name *string `locationName:"name" type:"string" required:"true"`
747 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
748748
749749 // A list of tags to associate with the pipeline at creation. Tags let you control
750750 // access to pipelines. For more information, see Controlling User Access to
763763 // Instead, you'll receive the pipeline identifier from the previous attempt.
764764 // The uniqueness of the name and unique identifier combination is scoped to
765765 // the AWS account or IAM user credentials.
766 UniqueId *string `locationName:"uniqueId" type:"string" required:"true"`
766 UniqueId *string `locationName:"uniqueId" min:"1" type:"string" required:"true"`
767767
768768 metadataCreatePipelineInput `json:"-" xml:"-"`
769769 }
786786 type CreatePipelineOutput struct {
787787 // The ID that AWS Data Pipeline assigns the newly created pipeline. For example,
788788 // df-06372391ZG65EXAMPLE.
789 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
789 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
790790
791791 metadataCreatePipelineOutput `json:"-" xml:"-"`
792792 }
813813 CancelActive *bool `locationName:"cancelActive" type:"boolean"`
814814
815815 // The ID of the pipeline.
816 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
816 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
817817
818818 metadataDeactivatePipelineInput `json:"-" xml:"-"`
819819 }
854854 // Contains the parameters for DeletePipeline.
855855 type DeletePipelineInput struct {
856856 // The ID of the pipeline.
857 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
857 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
858858
859859 metadataDeletePipelineInput `json:"-" xml:"-"`
860860 }
908908 ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
909909
910910 // The ID of the pipeline that contains the object definitions.
911 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
911 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
912912
913913 metadataDescribeObjectsInput `json:"-" xml:"-"`
914914 }
10081008 Expression *string `locationName:"expression" type:"string" required:"true"`
10091009
10101010 // The ID of the object.
1011 ObjectId *string `locationName:"objectId" type:"string" required:"true"`
1011 ObjectId *string `locationName:"objectId" min:"1" type:"string" required:"true"`
10121012
10131013 // The ID of the pipeline.
1014 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1014 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
10151015
10161016 metadataEvaluateExpressionInput `json:"-" xml:"-"`
10171017 }
10571057 // object (RefValue) but not as both.
10581058 type Field struct {
10591059 // The field identifier.
1060 Key *string `locationName:"key" type:"string" required:"true"`
1060 Key *string `locationName:"key" min:"1" type:"string" required:"true"`
10611061
10621062 // The field value, expressed as the identifier of another object.
1063 RefValue *string `locationName:"refValue" type:"string"`
1063 RefValue *string `locationName:"refValue" min:"1" type:"string"`
10641064
10651065 // The field value, expressed as a String.
10661066 StringValue *string `locationName:"stringValue" type:"string"`
10851085 // Contains the parameters for GetPipelineDefinition.
10861086 type GetPipelineDefinitionInput struct {
10871087 // The ID of the pipeline.
1088 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1088 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
10891089
10901090 // The version of the pipeline definition to retrieve. Set this parameter to
10911091 // latest (default) to use the last definition saved to the pipeline or active
12731273 // The attributes allowed or specified with a parameter object.
12741274 type ParameterAttribute struct {
12751275 // The field identifier.
1276 Key *string `locationName:"key" type:"string" required:"true"`
1276 Key *string `locationName:"key" min:"1" type:"string" required:"true"`
12771277
12781278 // The field value, expressed as a String.
12791279 StringValue *string `locationName:"stringValue" type:"string" required:"true"`
13011301 Attributes []*ParameterAttribute `locationName:"attributes" type:"list" required:"true"`
13021302
13031303 // The ID of the parameter object.
1304 Id *string `locationName:"id" type:"string" required:"true"`
1304 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
13051305
13061306 metadataParameterObject `json:"-" xml:"-"`
13071307 }
13231323 // A value or list of parameter values.
13241324 type ParameterValue struct {
13251325 // The ID of the parameter value.
1326 Id *string `locationName:"id" type:"string" required:"true"`
1326 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
13271327
13281328 // The field value, expressed as a String.
13291329 StringValue *string `locationName:"stringValue" type:"string" required:"true"`
13551355 Fields []*Field `locationName:"fields" type:"list" required:"true"`
13561356
13571357 // The name of the pipeline.
1358 Name *string `locationName:"name" type:"string" required:"true"`
1358 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
13591359
13601360 // The pipeline identifier that was assigned by AWS Data Pipeline. This is a
13611361 // string of the form df-297EG78HU43EEXAMPLE.
1362 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1362 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
13631363
13641364 // A list of tags to associated with a pipeline. Tags let you control access
13651365 // to pipelines. For more information, see Controlling User Access to Pipelines
13881388 type PipelineIdName struct {
13891389 // The ID of the pipeline that was assigned by AWS Data Pipeline. This is a
13901390 // string of the form df-297EG78HU43EEXAMPLE.
1391 Id *string `locationName:"id" type:"string"`
1391 Id *string `locationName:"id" min:"1" type:"string"`
13921392
13931393 // The name of the pipeline.
1394 Name *string `locationName:"name" type:"string"`
1394 Name *string `locationName:"name" min:"1" type:"string"`
13951395
13961396 metadataPipelineIdName `json:"-" xml:"-"`
13971397 }
14181418 Fields []*Field `locationName:"fields" type:"list" required:"true"`
14191419
14201420 // The ID of the object.
1421 Id *string `locationName:"id" type:"string" required:"true"`
1421 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
14221422
14231423 // The name of the object.
1424 Name *string `locationName:"name" type:"string" required:"true"`
1424 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
14251425
14261426 metadataPipelineObject `json:"-" xml:"-"`
14271427 }
14431443 // Contains the parameters for PollForTask.
14441444 type PollForTaskInput struct {
14451445 // The public DNS name of the calling task runner.
1446 Hostname *string `locationName:"hostname" type:"string"`
1446 Hostname *string `locationName:"hostname" min:"1" type:"string"`
14471447
14481448 // Identity information for the EC2 instance that is hosting the task runner.
14491449 // You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id.
15111511 ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
15121512
15131513 // The ID of the pipeline.
1514 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1514 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
15151515
15161516 // The objects that define the pipeline. These objects overwrite the existing
15171517 // pipeline definition.
16001600 Marker *string `locationName:"marker" type:"string"`
16011601
16021602 // The ID of the pipeline.
1603 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1603 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
16041604
16051605 // The query that defines the objects to be returned. The Query object can contain
16061606 // a maximum of ten selectors. The conditions in the query are limited to top-level
16631663 // Contains the parameters for RemoveTags.
16641664 type RemoveTagsInput struct {
16651665 // The ID of the pipeline.
1666 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1666 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
16671667
16681668 // The keys of the tags to remove.
16691669 TagKeys []*string `locationName:"tagKeys" type:"list" required:"true"`
17121712
17131713 // The ID of the task assigned to the task runner. This value is provided in
17141714 // the response for PollForTask.
1715 TaskId *string `locationName:"taskId" type:"string" required:"true"`
1715 TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
17161716
17171717 metadataReportTaskProgressInput `json:"-" xml:"-"`
17181718 }
17571757 // Contains the parameters for ReportTaskRunnerHeartbeat.
17581758 type ReportTaskRunnerHeartbeatInput struct {
17591759 // The public DNS name of the task runner.
1760 Hostname *string `locationName:"hostname" type:"string"`
1760 Hostname *string `locationName:"hostname" min:"1" type:"string"`
17611761
17621762 // The ID of the task runner. This value should be unique across your AWS account.
17631763 // In the case of AWS Data Pipeline Task Runner launched on a resource managed
17641764 // by AWS Data Pipeline, the web service provides a unique identifier when it
17651765 // launches the application. If you have written a custom task runner, you should
17661766 // assign a unique identifier for the task runner.
1767 TaskrunnerId *string `locationName:"taskrunnerId" type:"string" required:"true"`
1767 TaskrunnerId *string `locationName:"taskrunnerId" min:"1" type:"string" required:"true"`
17681768
17691769 // The type of task the task runner is configured to accept and process. The
17701770 // worker group is set as a field on objects in the pipeline when they are created.
18491849 ObjectIds []*string `locationName:"objectIds" type:"list" required:"true"`
18501850
18511851 // The ID of the pipeline that contains the objects.
1852 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
1852 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
18531853
18541854 // The status to be set on all the objects specified in objectIds. For components,
18551855 // use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.
19121912
19131913 // The ID of the task assigned to the task runner. This value is provided in
19141914 // the response for PollForTask.
1915 TaskId *string `locationName:"taskId" type:"string" required:"true"`
1915 TaskId *string `locationName:"taskId" min:"1" type:"string" required:"true"`
19161916
19171917 // If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully.
19181918 // Preconditions use false.
19631963 // The key name of a tag defined by a user. For more information, see Controlling
19641964 // User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
19651965 // in the AWS Data Pipeline Developer Guide.
1966 Key *string `locationName:"key" type:"string" required:"true"`
1966 Key *string `locationName:"key" min:"1" type:"string" required:"true"`
19671967
19681968 // The optional value portion of a tag defined by a user. For more information,
19691969 // see Controlling User Access to Pipelines (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-control-access.html)
19911991 type TaskObject struct {
19921992 // The ID of the pipeline task attempt object. AWS Data Pipeline uses this value
19931993 // to track how many times a task is attempted.
1994 AttemptId *string `locationName:"attemptId" type:"string"`
1994 AttemptId *string `locationName:"attemptId" min:"1" type:"string"`
19951995
19961996 // Connection information for the location where the task runner will publish
19971997 // the output of the task.
19981998 Objects map[string]*PipelineObject `locationName:"objects" type:"map"`
19991999
20002000 // The ID of the pipeline that provided the task.
2001 PipelineId *string `locationName:"pipelineId" type:"string"`
2001 PipelineId *string `locationName:"pipelineId" min:"1" type:"string"`
20022002
20032003 // An internal identifier for the task. This ID is passed to the SetTaskStatus
20042004 // and ReportTaskProgress actions.
2005 TaskId *string `locationName:"taskId" type:"string"`
2005 TaskId *string `locationName:"taskId" min:"1" type:"string"`
20062006
20072007 metadataTaskObject `json:"-" xml:"-"`
20082008 }
20302030 ParameterValues []*ParameterValue `locationName:"parameterValues" type:"list"`
20312031
20322032 // The ID of the pipeline.
2033 PipelineId *string `locationName:"pipelineId" type:"string" required:"true"`
2033 PipelineId *string `locationName:"pipelineId" min:"1" type:"string" required:"true"`
20342034
20352035 // The objects that define the pipeline changes to validate against the pipeline.
20362036 PipelineObjects []*PipelineObject `locationName:"pipelineObjects" type:"list" required:"true"`
20882088 Errors []*string `locationName:"errors" type:"list"`
20892089
20902090 // The identifier of the object that contains the validation error.
2091 Id *string `locationName:"id" type:"string"`
2091 Id *string `locationName:"id" min:"1" type:"string"`
20922092
20932093 metadataValidationError `json:"-" xml:"-"`
20942094 }
21122112 // by AWS Data Pipeline.
21132113 type ValidationWarning struct {
21142114 // The identifier of the object that contains the validation warning.
2115 Id *string `locationName:"id" type:"string"`
2115 Id *string `locationName:"id" min:"1" type:"string"`
21162116
21172117 // A description of the validation warning.
21182118 Warnings []*string `locationName:"warnings" type:"list"`
+63
-63
service/devicefarm/api.go less more
831831 // A container for account-level settings within AWS Device Farm.
832832 type AccountSettings struct {
833833 // The AWS account number specified in the AccountSettings container.
834 AwsAccountNumber *string `locationName:"awsAccountNumber" type:"string"`
834 AwsAccountNumber *string `locationName:"awsAccountNumber" min:"2" type:"string"`
835835
836836 // Returns the unmetered devices you have purchased.
837837 UnmeteredDevices map[string]*int64 `locationName:"unmeteredDevices" type:"map"`
856856 // Represents the output of a test. Examples of artifacts include logs and screenshots.
857857 type Artifact struct {
858858 // The artifact's ARN.
859 Arn *string `locationName:"arn" type:"string"`
859 Arn *string `locationName:"arn" min:"32" type:"string"`
860860
861861 // The artifact's file extension.
862862 Extension *string `locationName:"extension" type:"string"`
10031003 Name *string `locationName:"name" type:"string" required:"true"`
10041004
10051005 // The ARN of the project for the device pool.
1006 ProjectArn *string `locationName:"projectArn" type:"string" required:"true"`
1006 ProjectArn *string `locationName:"projectArn" min:"32" type:"string" required:"true"`
10071007
10081008 // The device pool's rules.
10091009 Rules []*Rule `locationName:"rules" type:"list" required:"true"`
11001100 Name *string `locationName:"name" type:"string" required:"true"`
11011101
11021102 // The ARN of the project for the upload.
1103 ProjectArn *string `locationName:"projectArn" type:"string" required:"true"`
1103 ProjectArn *string `locationName:"projectArn" min:"32" type:"string" required:"true"`
11041104
11051105 // The upload's upload type.
11061106 //
11671167 // Represents a device type that an app is tested against.
11681168 type Device struct {
11691169 // The device's ARN.
1170 Arn *string `locationName:"arn" type:"string"`
1170 Arn *string `locationName:"arn" min:"32" type:"string"`
11711171
11721172 // The device's carrier.
11731173 Carrier *string `locationName:"carrier" type:"string"`
12411241 // Represents a collection of device types.
12421242 type DevicePool struct {
12431243 // The device pool's ARN.
1244 Arn *string `locationName:"arn" type:"string"`
1244 Arn *string `locationName:"arn" min:"32" type:"string"`
12451245
12461246 // The device pool's description.
12471247 Description *string `locationName:"description" type:"string"`
13481348 // Represents a request to the get device request.
13491349 type GetDeviceInput struct {
13501350 // The device type's ARN.
1351 Arn *string `locationName:"arn" type:"string" required:"true"`
1351 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
13521352
13531353 metadataGetDeviceInput `json:"-" xml:"-"`
13541354 }
13921392 // Represents a request to the get device pool compatibility operation.
13931393 type GetDevicePoolCompatibilityInput struct {
13941394 // The ARN of the app that is associated with the specified device pool.
1395 AppArn *string `locationName:"appArn" type:"string" required:"true"`
1395 AppArn *string `locationName:"appArn" min:"32" type:"string" required:"true"`
13961396
13971397 // The device pool's ARN.
1398 DevicePoolArn *string `locationName:"devicePoolArn" type:"string" required:"true"`
1398 DevicePoolArn *string `locationName:"devicePoolArn" min:"32" type:"string" required:"true"`
13991399
14001400 // The test type for the specified device pool.
14011401 //
14661466 // Represents a request to the get device pool operation.
14671467 type GetDevicePoolInput struct {
14681468 // The device pool's ARN.
1469 Arn *string `locationName:"arn" type:"string" required:"true"`
1469 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
14701470
14711471 metadataGetDevicePoolInput `json:"-" xml:"-"`
14721472 }
15101510 // Represents a request to the get job operation.
15111511 type GetJobInput struct {
15121512 // The job's ARN.
1513 Arn *string `locationName:"arn" type:"string" required:"true"`
1513 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
15141514
15151515 metadataGetJobInput `json:"-" xml:"-"`
15161516 }
15541554 // Represents a request to the get project operation.
15551555 type GetProjectInput struct {
15561556 // The project's ARN.
1557 Arn *string `locationName:"arn" type:"string" required:"true"`
1557 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
15581558
15591559 metadataGetProjectInput `json:"-" xml:"-"`
15601560 }
15991599 // Represents a request to the get run operation.
16001600 type GetRunInput struct {
16011601 // The run's ARN.
1602 Arn *string `locationName:"arn" type:"string" required:"true"`
1602 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
16031603
16041604 metadataGetRunInput `json:"-" xml:"-"`
16051605 }
16431643 // Represents a request to the get suite operation.
16441644 type GetSuiteInput struct {
16451645 // The suite's ARN.
1646 Arn *string `locationName:"arn" type:"string" required:"true"`
1646 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
16471647
16481648 metadataGetSuiteInput `json:"-" xml:"-"`
16491649 }
16871687 // Represents a request to the get test operation.
16881688 type GetTestInput struct {
16891689 // The test's ARN.
1690 Arn *string `locationName:"arn" type:"string" required:"true"`
1690 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
16911691
16921692 metadataGetTestInput `json:"-" xml:"-"`
16931693 }
17311731 // Represents a request to the get upload operation.
17321732 type GetUploadInput struct {
17331733 // The upload's ARN.
1734 Arn *string `locationName:"arn" type:"string" required:"true"`
1734 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
17351735
17361736 metadataGetUploadInput `json:"-" xml:"-"`
17371737 }
18101810 // Represents a device.
18111811 type Job struct {
18121812 // The job's ARN.
1813 Arn *string `locationName:"arn" type:"string"`
1813 Arn *string `locationName:"arn" min:"32" type:"string"`
18141814
18151815 // The job's result counters.
18161816 Counters *Counters `locationName:"counters" type:"structure"`
19111911 // Represents a request to the list artifacts operation.
19121912 type ListArtifactsInput struct {
19131913 // The Run, Job, Suite, or Test ARN.
1914 Arn *string `locationName:"arn" type:"string" required:"true"`
1914 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
19151915
19161916 // An identifier that was returned from the previous call to this operation,
19171917 // which can be used to return the next set of items in the list.
1918 NextToken *string `locationName:"nextToken" type:"string"`
1918 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
19191919
19201920 // The artifacts' type.
19211921 //
19501950 // If the number of items that are returned is significantly large, this is
19511951 // an identifier that is also returned, which can be used in a subsequent call
19521952 // to this operation to return the next set of items in the list.
1953 NextToken *string `locationName:"nextToken" type:"string"`
1953 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
19541954
19551955 metadataListArtifactsOutput `json:"-" xml:"-"`
19561956 }
19721972 // Represents the result of a list device pools request.
19731973 type ListDevicePoolsInput struct {
19741974 // The project ARN.
1975 Arn *string `locationName:"arn" type:"string" required:"true"`
1975 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
19761976
19771977 // An identifier that was returned from the previous call to this operation,
19781978 // which can be used to return the next set of items in the list.
1979 NextToken *string `locationName:"nextToken" type:"string"`
1979 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
19801980
19811981 // The device pools' type.
19821982 //
20122012 // If the number of items that are returned is significantly large, this is
20132013 // an identifier that is also returned, which can be used in a subsequent call
20142014 // to this operation to return the next set of items in the list.
2015 NextToken *string `locationName:"nextToken" type:"string"`
2015 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
20162016
20172017 metadataListDevicePoolsOutput `json:"-" xml:"-"`
20182018 }
20342034 // Represents the result of a list devices request.
20352035 type ListDevicesInput struct {
20362036 // The device types' ARNs.
2037 Arn *string `locationName:"arn" type:"string"`
2037 Arn *string `locationName:"arn" min:"32" type:"string"`
20382038
20392039 // An identifier that was returned from the previous call to this operation,
20402040 // which can be used to return the next set of items in the list.
2041 NextToken *string `locationName:"nextToken" type:"string"`
2041 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
20422042
20432043 metadataListDevicesInput `json:"-" xml:"-"`
20442044 }
20652065 // If the number of items that are returned is significantly large, this is
20662066 // an identifier that is also returned, which can be used in a subsequent call
20672067 // to this operation to return the next set of items in the list.
2068 NextToken *string `locationName:"nextToken" type:"string"`
2068 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
20692069
20702070 metadataListDevicesOutput `json:"-" xml:"-"`
20712071 }
20872087 // Represents a request to the list jobs operation.
20882088 type ListJobsInput struct {
20892089 // The jobs' ARNs.
2090 Arn *string `locationName:"arn" type:"string" required:"true"`
2090 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
20912091
20922092 // An identifier that was returned from the previous call to this operation,
20932093 // which can be used to return the next set of items in the list.
2094 NextToken *string `locationName:"nextToken" type:"string"`
2094 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
20952095
20962096 metadataListJobsInput `json:"-" xml:"-"`
20972097 }
21182118 // If the number of items that are returned is significantly large, this is
21192119 // an identifier that is also returned, which can be used in a subsequent call
21202120 // to this operation to return the next set of items in the list.
2121 NextToken *string `locationName:"nextToken" type:"string"`
2121 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
21222122
21232123 metadataListJobsOutput `json:"-" xml:"-"`
21242124 }
21402140 // Represents a request to the list projects operation.
21412141 type ListProjectsInput struct {
21422142 // The projects' ARNs.
2143 Arn *string `locationName:"arn" type:"string"`
2143 Arn *string `locationName:"arn" min:"32" type:"string"`
21442144
21452145 // An identifier that was returned from the previous call to this operation,
21462146 // which can be used to return the next set of items in the list.
2147 NextToken *string `locationName:"nextToken" type:"string"`
2147 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
21482148
21492149 metadataListProjectsInput `json:"-" xml:"-"`
21502150 }
21682168 // If the number of items that are returned is significantly large, this is
21692169 // an identifier that is also returned, which can be used in a subsequent call
21702170 // to this operation to return the next set of items in the list.
2171 NextToken *string `locationName:"nextToken" type:"string"`
2171 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
21722172
21732173 // Information about the projects.
21742174 Projects []*Project `locationName:"projects" type:"list"`
21932193 // Represents a request to the list runs operation.
21942194 type ListRunsInput struct {
21952195 // The runs' ARNs.
2196 Arn *string `locationName:"arn" type:"string" required:"true"`
2196 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
21972197
21982198 // An identifier that was returned from the previous call to this operation,
21992199 // which can be used to return the next set of items in the list.
2200 NextToken *string `locationName:"nextToken" type:"string"`
2200 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
22012201
22022202 metadataListRunsInput `json:"-" xml:"-"`
22032203 }
22212221 // If the number of items that are returned is significantly large, this is
22222222 // an identifier that is also returned, which can be used in a subsequent call
22232223 // to this operation to return the next set of items in the list.
2224 NextToken *string `locationName:"nextToken" type:"string"`
2224 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
22252225
22262226 // Information about the runs.
22272227 Runs []*Run `locationName:"runs" type:"list"`
22462246 // Represents a request to the list samples operation.
22472247 type ListSamplesInput struct {
22482248 // The samples' ARNs.
2249 Arn *string `locationName:"arn" type:"string" required:"true"`
2249 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
22502250
22512251 // An identifier that was returned from the previous call to this operation,
22522252 // which can be used to return the next set of items in the list.
2253 NextToken *string `locationName:"nextToken" type:"string"`
2253 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
22542254
22552255 metadataListSamplesInput `json:"-" xml:"-"`
22562256 }
22742274 // If the number of items that are returned is significantly large, this is
22752275 // an identifier that is also returned, which can be used in a subsequent call
22762276 // to this operation to return the next set of items in the list.
2277 NextToken *string `locationName:"nextToken" type:"string"`
2277 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
22782278
22792279 // Information about the samples.
22802280 Samples []*Sample `locationName:"samples" type:"list"`
22992299 // Represents a request to the list suites operation.
23002300 type ListSuitesInput struct {
23012301 // The suites' ARNs.
2302 Arn *string `locationName:"arn" type:"string" required:"true"`
2302 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
23032303
23042304 // An identifier that was returned from the previous call to this operation,
23052305 // which can be used to return the next set of items in the list.
2306 NextToken *string `locationName:"nextToken" type:"string"`
2306 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
23072307
23082308 metadataListSuitesInput `json:"-" xml:"-"`
23092309 }
23272327 // If the number of items that are returned is significantly large, this is
23282328 // an identifier that is also returned, which can be used in a subsequent call
23292329 // to this operation to return the next set of items in the list.
2330 NextToken *string `locationName:"nextToken" type:"string"`
2330 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
23312331
23322332 // Information about the suites.
23332333 Suites []*Suite `locationName:"suites" type:"list"`
23522352 // Represents a request to the list tests operation.
23532353 type ListTestsInput struct {
23542354 // The tests' ARNs.
2355 Arn *string `locationName:"arn" type:"string" required:"true"`
2355 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
23562356
23572357 // An identifier that was returned from the previous call to this operation,
23582358 // which can be used to return the next set of items in the list.
2359 NextToken *string `locationName:"nextToken" type:"string"`
2359 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
23602360
23612361 metadataListTestsInput `json:"-" xml:"-"`
23622362 }
23802380 // If the number of items that are returned is significantly large, this is
23812381 // an identifier that is also returned, which can be used in a subsequent call
23822382 // to this operation to return the next set of items in the list.
2383 NextToken *string `locationName:"nextToken" type:"string"`
2383 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
23842384
23852385 // Information about the tests.
23862386 Tests []*Test `locationName:"tests" type:"list"`
24052405 // Represents a request to the list unique problems operation.
24062406 type ListUniqueProblemsInput struct {
24072407 // The unique problems' ARNs.
2408 Arn *string `locationName:"arn" type:"string" required:"true"`
2408 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
24092409
24102410 // An identifier that was returned from the previous call to this operation,
24112411 // which can be used to return the next set of items in the list.
2412 NextToken *string `locationName:"nextToken" type:"string"`
2412 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
24132413
24142414 metadataListUniqueProblemsInput `json:"-" xml:"-"`
24152415 }
24332433 // If the number of items that are returned is significantly large, this is
24342434 // an identifier that is also returned, which can be used in a subsequent call
24352435 // to this operation to return the next set of items in the list.
2436 NextToken *string `locationName:"nextToken" type:"string"`
2436 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
24372437
24382438 // Information about the unique problems.
24392439 //
24742474 // Represents a request to the list uploads operation.
24752475 type ListUploadsInput struct {
24762476 // The uploads' ARNs.
2477 Arn *string `locationName:"arn" type:"string" required:"true"`
2477 Arn *string `locationName:"arn" min:"32" type:"string" required:"true"`
24782478
24792479 // An identifier that was returned from the previous call to this operation,
24802480 // which can be used to return the next set of items in the list.
2481 NextToken *string `locationName:"nextToken" type:"string"`
2481 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
24822482
24832483 metadataListUploadsInput `json:"-" xml:"-"`
24842484 }
25022502 // If the number of items that are returned is significantly large, this is
25032503 // an identifier that is also returned, which can be used in a subsequent call
25042504 // to this operation to return the next set of items in the list.
2505 NextToken *string `locationName:"nextToken" type:"string"`
2505 NextToken *string `locationName:"nextToken" min:"4" type:"string"`
25062506
25072507 // Information about the uploads.
25082508 Uploads []*Upload `locationName:"uploads" type:"list"`
26112611 // Information about a problem detail.
26122612 type ProblemDetail struct {
26132613 // The problem detail's ARN.
2614 Arn *string `locationName:"arn" type:"string"`
2614 Arn *string `locationName:"arn" min:"32" type:"string"`
26152615
26162616 // The problem detail's name.
26172617 Name *string `locationName:"name" type:"string"`
26372637 // tests.
26382638 type Project struct {
26392639 // The project's ARN.
2640 Arn *string `locationName:"arn" type:"string"`
2640 Arn *string `locationName:"arn" min:"32" type:"string"`
26412641
26422642 // When the project was created.
26432643 Created *time.Time `locationName:"created" type:"timestamp" timestampFormat:"unix"`
27712771 // Represents an app on a set of devices with a specific test and configuration.
27722772 type Run struct {
27732773 // The run's ARN.
2774 Arn *string `locationName:"arn" type:"string"`
2774 Arn *string `locationName:"arn" min:"32" type:"string"`
27752775
27762776 // Specifies the billing method for a test run: metered or unmetered. If the
27772777 // parameter is not specified, the default value is unmetered.
28882888 // Represents a sample of performance data.
28892889 type Sample struct {
28902890 // The sample's ARN.
2891 Arn *string `locationName:"arn" type:"string"`
2891 Arn *string `locationName:"arn" min:"32" type:"string"`
28922892
28932893 // The sample's type.
28942894 //
29682968 // The ARN of the extra data for the run. The extra data is a .zip file that
29692969 // AWS Device Farm will extract to external data for Android or the app's sandbox
29702970 // for iOS.
2971 ExtraDataPackageArn *string `locationName:"extraDataPackageArn" type:"string"`
2971 ExtraDataPackageArn *string `locationName:"extraDataPackageArn" min:"32" type:"string"`
29722972
29732973 // Information about the locale that is used for the run.
29742974 Locale *string `locationName:"locale" type:"string"`
29772977 Location *Location `locationName:"location" type:"structure"`
29782978
29792979 // Reserved for internal use.
2980 NetworkProfileArn *string `locationName:"networkProfileArn" type:"string"`
2980 NetworkProfileArn *string `locationName:"networkProfileArn" min:"32" type:"string"`
29812981
29822982 // Information about the radio states for the run.
29832983 Radios *Radios `locationName:"radios" type:"structure"`
30023002 // Represents a request to the schedule run operation.
30033003 type ScheduleRunInput struct {
30043004 // The ARN of the app to schedule a run.
3005 AppArn *string `locationName:"appArn" type:"string" required:"true"`
3005 AppArn *string `locationName:"appArn" min:"32" type:"string" required:"true"`
30063006
30073007 // Information about the settings for the run to be scheduled.
30083008 Configuration *ScheduleRunConfiguration `locationName:"configuration" type:"structure"`
30093009
30103010 // The ARN of the device pool for the run to be scheduled.
3011 DevicePoolArn *string `locationName:"devicePoolArn" type:"string" required:"true"`
3011 DevicePoolArn *string `locationName:"devicePoolArn" min:"32" type:"string" required:"true"`
30123012
30133013 // The name for the run to be scheduled.
30143014 Name *string `locationName:"name" type:"string"`
30153015
30163016 // The ARN of the project for the run to be scheduled.
3017 ProjectArn *string `locationName:"projectArn" type:"string" required:"true"`
3017 ProjectArn *string `locationName:"projectArn" min:"32" type:"string" required:"true"`
30183018
30193019 // Information about the test for the run to be scheduled.
30203020 Test *ScheduleRunTest `locationName:"test" type:"structure" required:"true"`
30673067 Parameters map[string]*string `locationName:"parameters" type:"map"`
30683068
30693069 // The ARN of the uploaded test that will be run.
3070 TestPackageArn *string `locationName:"testPackageArn" type:"string"`
3070 TestPackageArn *string `locationName:"testPackageArn" min:"32" type:"string"`
30713071
30723072 // The test's type.
30733073 //
31133113 // Represents a collection of one or more tests.
31143114 type Suite struct {
31153115 // The suite's ARN.
3116 Arn *string `locationName:"arn" type:"string"`
3116 Arn *string `locationName:"arn" min:"32" type:"string"`
31173117
31183118 // The suite's result counters.
31193119 Counters *Counters `locationName:"counters" type:"structure"`
32113211 // Represents a condition that is evaluated.
32123212 type Test struct {
32133213 // The test's ARN.
3214 Arn *string `locationName:"arn" type:"string"`
3214 Arn *string `locationName:"arn" min:"32" type:"string"`
32153215
32163216 // The test's result counters.
32173217 Counters *Counters `locationName:"counters" type:"structure"`
33343334 // An app or a set of one or more tests to upload or that have been uploaded.
33353335 type Upload struct {
33363336 // The upload's ARN.
3337 Arn *string `locationName:"arn" type:"string"`
3337 Arn *string `locationName:"arn" min:"32" type:"string"`
33383338
33393339 // The upload's content type (for example, "application/octet-stream").
33403340 ContentType *string `locationName:"contentType" type:"string"`
+21
-21
service/directoryservice/api.go less more
508508 // Represents a named directory attribute.
509509 type Attribute struct {
510510 // The name of the attribute.
511 Name *string `type:"string"`
511 Name *string `min:"1" type:"string"`
512512
513513 // The value of the attribute.
514514 Value *string `type:"string"`
537537 ComputerAttributes []*Attribute `type:"list"`
538538
539539 // The identifier of the computer.
540 ComputerId *string `type:"string"`
540 ComputerId *string `min:"1" type:"string"`
541541
542542 // The computer name.
543 ComputerName *string `type:"string"`
543 ComputerName *string `min:"1" type:"string"`
544544
545545 metadataComputer `json:"-" xml:"-"`
546546 }
572572 Name *string `type:"string" required:"true"`
573573
574574 // The password for the on-premises user account.
575 Password *string `type:"string" required:"true"`
575 Password *string `min:"1" type:"string" required:"true"`
576576
577577 // The NetBIOS name of the on-premises directory, such as CORP.
578578 ShortName *string `type:"string"`
625625 //
626626 // The alias must be unique amongst all aliases in AWS. This operation will
627627 // throw an EntityAlreadyExistsException if this alias already exists.
628 Alias *string `type:"string" required:"true"`
628 Alias *string `min:"1" type:"string" required:"true"`
629629
630630 // The identifier of the directory to create the alias for.
631631 DirectoryId *string `type:"string" required:"true"`
650650 // Contains the results of the CreateAlias operation.
651651 type CreateAliasOutput struct {
652652 // The alias for the directory.
653 Alias *string `type:"string"`
653 Alias *string `min:"1" type:"string"`
654654
655655 // The identifier of the directory.
656656 DirectoryId *string `type:"string"`
679679 ComputerAttributes []*Attribute `type:"list"`
680680
681681 // The name of the computer account.
682 ComputerName *string `type:"string" required:"true"`
682 ComputerName *string `min:"1" type:"string" required:"true"`
683683
684684 // The identifier of the directory to create the computer account in.
685685 DirectoryId *string `type:"string" required:"true"`
686686
687687 // The fully-qualified distinguished name of the organizational unit to place
688688 // the computer account in.
689 OrganizationalUnitDistinguishedName *string `type:"string"`
689 OrganizationalUnitDistinguishedName *string `min:"1" type:"string"`
690690
691691 // A one-time password that is used to join the computer to the directory. You
692692 // should generate a random, strong password to use for this parameter.
693 Password *string `type:"string" required:"true"`
693 Password *string `min:"8" type:"string" required:"true"`
694694
695695 metadataCreateComputerInput `json:"-" xml:"-"`
696696 }
10701070 // to the directory. This account must have the following privileges:
10711071 //
10721072 // Read users and groups Create computer objects Join computers to the domain
1073 CustomerUserName *string `type:"string" required:"true"`
1073 CustomerUserName *string `min:"1" type:"string" required:"true"`
10741074
10751075 // A list of subnet identifiers in the VPC that the AD Connector is created
10761076 // in.
11051105 ConnectIps []*string `type:"list"`
11061106
11071107 // The username of the service account in the on-premises directory.
1108 CustomerUserName *string `type:"string"`
1108 CustomerUserName *string `min:"1" type:"string"`
11091109
11101110 // The security group identifier for the AD Connector directory.
11111111 SecurityGroupId *string `type:"string"`
11361136 // Contains information about an AWS Directory Service directory.
11371137 type DirectoryDescription struct {
11381138 // The access URL for the directory, such as http://<alias>.awsapps.com.
1139 AccessUrl *string `type:"string"`
1139 AccessUrl *string `min:"1" type:"string"`
11401140
11411141 // The alias for the directory.
1142 Alias *string `type:"string"`
1142 Alias *string `min:"1" type:"string"`
11431143
11441144 // A DirectoryConnectSettingsDescription object that contains additional information
11451145 // about an AD Connector directory. This member is only present if the directory
13611361 // The password of an alternate account to use to disable single-sign on. This
13621362 // is only used for AD Connector directories. See the UserName parameter for
13631363 // more information.
1364 Password *string `type:"string"`
1364 Password *string `min:"1" type:"string"`
13651365
13661366 // The username of an alternate account to use to disable single-sign on. This
13671367 // is only used for AD Connector directories. This account must have privileges
13721372 // and Password parameters. These credentials are only used to disable single
13731373 // sign-on and are not stored by the service. The AD Connector service account
13741374 // is not changed.
1375 UserName *string `type:"string"`
1375 UserName *string `min:"1" type:"string"`
13761376
13771377 metadataDisableSsoInput `json:"-" xml:"-"`
13781378 }
14621462 // The password of an alternate account to use to enable single-sign on. This
14631463 // is only used for AD Connector directories. See the UserName parameter for
14641464 // more information.
1465 Password *string `type:"string"`
1465 Password *string `min:"1" type:"string"`
14661466
14671467 // The username of an alternate account to use to enable single-sign on. This
14681468 // is only used for AD Connector directories. This account must have privileges
14731473 // Password parameters. These credentials are only used to enable single sign-on
14741474 // and are not stored by the service. The AD Connector service account is not
14751475 // changed.
1476 UserName *string `type:"string"`
1476 UserName *string `min:"1" type:"string"`
14771477
14781478 metadataEnableSsoInput `json:"-" xml:"-"`
14791479 }
16051605 AuthenticationProtocol *string `type:"string" enum:"RadiusAuthenticationProtocol"`
16061606
16071607 // Not currently used.
1608 DisplayLabel *string `type:"string"`
1608 DisplayLabel *string `min:"1" type:"string"`
16091609
16101610 // The port that your RADIUS server is using for communications. Your on-premises
16111611 // network must allow inbound traffic over this port from the AWS Directory
16121612 // Service servers.
1613 RadiusPort *int64 `type:"integer"`
1613 RadiusPort *int64 `min:"1025" type:"integer"`
16141614
16151615 // The maximum number of times that communication with the RADIUS server is
16161616 // attempted.
16211621 RadiusServers []*string `type:"list"`
16221622
16231623 // The amount of time, in seconds, to wait for the RADIUS server to respond.
1624 RadiusTimeout *int64 `type:"integer"`
1624 RadiusTimeout *int64 `min:"1" type:"integer"`
16251625
16261626 // The shared secret code that was specified when your RADIUS endpoints were
16271627 // created.
1628 SharedSecret *string `type:"string"`
1628 SharedSecret *string `min:"8" type:"string"`
16291629
16301630 // Not currently used.
16311631 UseSameUsername *bool `type:"boolean"`
+52
-52
service/dynamodb/api.go less more
683683 // Represents an attribute for describing the key schema for the table and indexes.
684684 type AttributeDefinition struct {
685685 // A name for the attribute.
686 AttributeName *string `type:"string" required:"true"`
686 AttributeName *string `min:"1" type:"string" required:"true"`
687687
688688 // The data type for the attribute.
689689 AttributeType *string `type:"string" required:"true" enum:"ScalarAttributeType"`
943943 // Note that AttributesToGet has no effect on provisioned throughput consumption.
944944 // DynamoDB determines capacity units consumed based on item size, not on the
945945 // amount of data that is returned to an application.
946 RequestItems map[string]*KeysAndAttributes `type:"map" required:"true"`
946 RequestItems map[string]*KeysAndAttributes `min:"1" type:"map" required:"true"`
947947
948948 // Determines the level of detail about provisioned throughput consumption that
949949 // is returned in the response:
10151015 //
10161016 // If there are no unprocessed keys remaining, the response contains an empty
10171017 // UnprocessedKeys map.
1018 UnprocessedKeys map[string]*KeysAndAttributes `type:"map"`
1018 UnprocessedKeys map[string]*KeysAndAttributes `min:"1" type:"map"`
10191019
10201020 metadataBatchGetItemOutput `json:"-" xml:"-"`
10211021 }
10621062 // If you specify any attributes that are part of an index key, then the data
10631063 // types for those attributes must match those of the schema in the table's
10641064 // attribute definition.
1065 RequestItems map[string][]*WriteRequest `type:"map" required:"true"`
1065 RequestItems map[string][]*WriteRequest `min:"1" type:"map" required:"true"`
10661066
10671067 // Determines the level of detail about provisioned throughput consumption that
10681068 // is returned in the response:
11651165 //
11661166 // If there are no unprocessed items remaining, the response contains an
11671167 // empty UnprocessedItems map.
1168 UnprocessedItems map[string][]*WriteRequest `type:"map"`
1168 UnprocessedItems map[string][]*WriteRequest `min:"1" type:"map"`
11691169
11701170 metadataBatchWriteItemOutput `json:"-" xml:"-"`
11711171 }
14051405 Table *Capacity `type:"structure"`
14061406
14071407 // The name of the table that was affected by the operation.
1408 TableName *string `type:"string"`
1408 TableName *string `min:"3" type:"string"`
14091409
14101410 metadataConsumedCapacity `json:"-" xml:"-"`
14111411 }
14271427 // Represents a new global secondary index to be added to an existing table.
14281428 type CreateGlobalSecondaryIndexAction struct {
14291429 // The name of the global secondary index to be created.
1430 IndexName *string `type:"string" required:"true"`
1430 IndexName *string `min:"3" type:"string" required:"true"`
14311431
14321432 // The key schema for the global secondary index.
1433 KeySchema []*KeySchemaElement `type:"list" required:"true"`
1433 KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`
14341434
14351435 // Represents attributes that are copied (projected) from the table into an
14361436 // index. These are in addition to the primary key attributes and index key
15191519 //
15201520 // For more information, see Specifying the Primary Key (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#WorkingWithTables.primary.key)
15211521 // in the Amazon DynamoDB Developer Guide.
1522 KeySchema []*KeySchemaElement `type:"list" required:"true"`
1522 KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`
15231523
15241524 // One or more local secondary indexes (the maximum is five) to be created on
15251525 // the table. Each index is scoped to a given hash key value. There is a 10
15861586 StreamSpecification *StreamSpecification `type:"structure"`
15871587
15881588 // The name of the table to create.
1589 TableName *string `type:"string" required:"true"`
1589 TableName *string `min:"3" type:"string" required:"true"`
15901590
15911591 metadataCreateTableInput `json:"-" xml:"-"`
15921592 }
16301630 // Represents a global secondary index to be deleted from an existing table.
16311631 type DeleteGlobalSecondaryIndexAction struct {
16321632 // The name of the global secondary index to be deleted.
1633 IndexName *string `type:"string" required:"true"`
1633 IndexName *string `min:"3" type:"string" required:"true"`
16341634
16351635 metadataDeleteGlobalSecondaryIndexAction `json:"-" xml:"-"`
16361636 }
19881988 ReturnValues *string `type:"string" enum:"ReturnValue"`
19891989
19901990 // The name of the table from which to delete the item.
1991 TableName *string `type:"string" required:"true"`
1991 TableName *string `min:"3" type:"string" required:"true"`
19921992
19931993 metadataDeleteItemInput `json:"-" xml:"-"`
19941994 }
20872087 // Represents the input of a DeleteTable operation.
20882088 type DeleteTableInput struct {
20892089 // The name of the table to delete.
2090 TableName *string `type:"string" required:"true"`
2090 TableName *string `min:"3" type:"string" required:"true"`
20912091
20922092 metadataDeleteTableInput `json:"-" xml:"-"`
20932093 }
21312131 // Represents the input of a DescribeTable operation.
21322132 type DescribeTableInput struct {
21332133 // The name of the table to describe.
2134 TableName *string `type:"string" required:"true"`
2134 TableName *string `min:"3" type:"string" required:"true"`
21352135
21362136 metadataDescribeTableInput `json:"-" xml:"-"`
21372137 }
24062406 // Note that AttributesToGet has no effect on provisioned throughput consumption.
24072407 // DynamoDB determines capacity units consumed based on item size, not on the
24082408 // amount of data that is returned to an application.
2409 AttributesToGet []*string `type:"list"`
2409 AttributesToGet []*string `min:"1" type:"list"`
24102410
24112411 // Determines the read consistency model: If set to true, then the operation
24122412 // uses strongly consistent reads; otherwise, the operation uses eventually
24902490 ReturnConsumedCapacity *string `type:"string" enum:"ReturnConsumedCapacity"`
24912491
24922492 // The name of the table containing the requested item.
2493 TableName *string `type:"string" required:"true"`
2493 TableName *string `min:"3" type:"string" required:"true"`
24942494
24952495 metadataGetItemInput `json:"-" xml:"-"`
24962496 }
25432543 type GlobalSecondaryIndex struct {
25442544 // The name of the global secondary index. The name must be unique among all
25452545 // other indexes on this table.
2546 IndexName *string `type:"string" required:"true"`
2546 IndexName *string `min:"3" type:"string" required:"true"`
25472547
25482548 // The complete key schema for a global secondary index, which consists of one
25492549 // or more pairs of attribute names and key types (HASH or RANGE).
2550 KeySchema []*KeySchemaElement `type:"list" required:"true"`
2550 KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`
25512551
25522552 // Represents attributes that are copied (projected) from the table into an
25532553 // index. These are in addition to the primary key attributes and index key
25962596 IndexArn *string `type:"string"`
25972597
25982598 // The name of the global secondary index.
2599 IndexName *string `type:"string"`
2599 IndexName *string `min:"3" type:"string"`
26002600
26012601 // The total size of the specified index, in bytes. DynamoDB updates this value
26022602 // approximately every six hours. Recent changes might not be reflected in this
26202620
26212621 // The complete key schema for the global secondary index, consisting of one
26222622 // or more pairs of attribute names and key types (HASH or RANGE).
2623 KeySchema []*KeySchemaElement `type:"list"`
2623 KeySchema []*KeySchemaElement `min:"1" type:"list"`
26242624
26252625 // Represents attributes that are copied (projected) from the table into an
26262626 // index. These are in addition to the primary key attributes and index key
27402740 // the hash attribute, and another KeySchemaElement for the range attribute.
27412741 type KeySchemaElement struct {
27422742 // The name of a key attribute.
2743 AttributeName *string `type:"string" required:"true"`
2743 AttributeName *string `min:"1" type:"string" required:"true"`
27442744
27452745 // The attribute data, consisting of the data type and the attribute value itself.
27462746 KeyType *string `type:"string" required:"true" enum:"KeyType"`
27732773 // One or more attributes to retrieve from the table or index. If no attribute
27742774 // names are specified then all attributes will be returned. If any of the specified
27752775 // attributes are not found, they will not appear in the result.
2776 AttributesToGet []*string `type:"list"`
2776 AttributesToGet []*string `min:"1" type:"list"`
27772777
27782778 // The consistency of a read operation. If set to true, then a strongly consistent
27792779 // read is used; otherwise, an eventually consistent read is used.
28172817
28182818 // The primary key attribute values that define the items and the attributes
28192819 // associated with the items.
2820 Keys []map[string]*AttributeValue `type:"list" required:"true"`
2820 Keys []map[string]*AttributeValue `min:"1" type:"list" required:"true"`
28212821
28222822 // A string that identifies one or more attributes to retrieve from the table.
28232823 // These attributes can include scalars, sets, or elements of a JSON document.
28552855 // The first table name that this operation will evaluate. Use the value that
28562856 // was returned for LastEvaluatedTableName in a previous operation, so that
28572857 // you can obtain the next page of results.
2858 ExclusiveStartTableName *string `type:"string"`
2858 ExclusiveStartTableName *string `min:"3" type:"string"`
28592859
28602860 // A maximum number of table names to return. If this parameter is not specified,
28612861 // the limit is 100.
2862 Limit *int64 `type:"integer"`
2862 Limit *int64 `min:"1" type:"integer"`
28632863
28642864 metadataListTablesInput `json:"-" xml:"-"`
28652865 }
28862886 //
28872887 // If you do not receive a LastEvaluatedTableName value in the response, this
28882888 // means that there are no more table names to be retrieved.
2889 LastEvaluatedTableName *string `type:"string"`
2889 LastEvaluatedTableName *string `min:"3" type:"string"`
28902890
28912891 // The names of the tables associated with the current account at the current
28922892 // endpoint. The maximum size of this array is 100.
29172917 type LocalSecondaryIndex struct {
29182918 // The name of the local secondary index. The name must be unique among all
29192919 // other indexes on this table.
2920 IndexName *string `type:"string" required:"true"`
2920 IndexName *string `min:"3" type:"string" required:"true"`
29212921
29222922 // The complete key schema for the local secondary index, consisting of one
29232923 // or more pairs of attribute names and key types (HASH or RANGE).
2924 KeySchema []*KeySchemaElement `type:"list" required:"true"`
2924 KeySchema []*KeySchemaElement `min:"1" type:"list" required:"true"`
29252925
29262926 // Represents attributes that are copied (projected) from the table into an
29272927 // index. These are in addition to the primary key attributes and index key
29512951 IndexArn *string `type:"string"`
29522952
29532953 // Represents the name of the local secondary index.
2954 IndexName *string `type:"string"`
2954 IndexName *string `min:"3" type:"string"`
29552955
29562956 // The total size of the specified index, in bytes. DynamoDB updates this value
29572957 // approximately every six hours. Recent changes might not be reflected in this
29642964
29652965 // The complete index key schema, which consists of one or more pairs of attribute
29662966 // names and key types (HASH or RANGE).
2967 KeySchema []*KeySchemaElement `type:"list"`
2967 KeySchema []*KeySchemaElement `min:"1" type:"list"`
29682968
29692969 // Represents attributes that are copied (projected) from the table into an
29702970 // index. These are in addition to the primary key attributes and index key
29982998 // across all of the local secondary indexes, must not exceed 20. If you project
29992999 // the same attribute into two different indexes, this counts as two distinct
30003000 // attributes when determining the total.
3001 NonKeyAttributes []*string `type:"list"`
3001 NonKeyAttributes []*string `min:"1" type:"list"`
30023002
30033003 // The set of attributes that are projected into the index:
30043004 //
30383038 // DynamoDB returns a ThrottlingException. For more information, see Specifying
30393039 // Read and Write Requirements (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
30403040 // in the Amazon DynamoDB Developer Guide.
3041 ReadCapacityUnits *int64 `type:"long" required:"true"`
3041 ReadCapacityUnits *int64 `min:"1" type:"long" required:"true"`
30423042
30433043 // The maximum number of writes consumed per second before DynamoDB returns
30443044 // a ThrottlingException. For more information, see Specifying Read and Write
30453045 // Requirements (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput)
30463046 // in the Amazon DynamoDB Developer Guide.
3047 WriteCapacityUnits *int64 `type:"long" required:"true"`
3047 WriteCapacityUnits *int64 `min:"1" type:"long" required:"true"`
30483048
30493049 metadataProvisionedThroughput `json:"-" xml:"-"`
30503050 }
30763076 // UTC calendar day. For current maximums on provisioned throughput decreases,
30773077 // see Limits (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html)
30783078 // in the Amazon DynamoDB Developer Guide.
3079 NumberOfDecreasesToday *int64 `type:"long"`
3079 NumberOfDecreasesToday *int64 `min:"1" type:"long"`
30803080
30813081 // The maximum number of strongly consistent reads consumed per second before
30823082 // DynamoDB returns a ThrottlingException. Eventually consistent reads require
30833083 // less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
30843084 // per second provides 100 eventually consistent ReadCapacityUnits per second.
3085 ReadCapacityUnits *int64 `type:"long"`
3085 ReadCapacityUnits *int64 `min:"1" type:"long"`
30863086
30873087 // The maximum number of writes consumed per second before DynamoDB returns
30883088 // a ThrottlingException.
3089 WriteCapacityUnits *int64 `type:"long"`
3089 WriteCapacityUnits *int64 `min:"1" type:"long"`
30903090
30913091 metadataProvisionedThroughputDescription `json:"-" xml:"-"`
30923092 }
34583458 ReturnValues *string `type:"string" enum:"ReturnValue"`
34593459
34603460 // The name of the table to contain the item.
3461 TableName *string `type:"string" required:"true"`
3461 TableName *string `min:"3" type:"string" required:"true"`
34623462
34633463 metadataPutItemInput `json:"-" xml:"-"`
34643464 }
35883588 // If you query a global secondary index, you can only request attributes that
35893589 // are projected into the index. Global secondary index queries cannot fetch
35903590 // attributes from the parent table.
3591 AttributesToGet []*string `type:"list"`
3591 AttributesToGet []*string `min:"1" type:"list"`
35923592
35933593 // This is a legacy parameter, for backward compatibility. New applications
35943594 // should use FilterExpression instead. Do not combine legacy parameters and
37013701 // The name of an index to query. This index can be any local secondary index
37023702 // or global secondary index on the table. Note that if you use the IndexName
37033703 // parameter, you must also provide TableName.
3704 IndexName *string `type:"string"`
3704 IndexName *string `min:"3" type:"string"`
37053705
37063706 // The condition that specifies the key value(s) for items to be retrieved by
37073707 // the Query action.
38833883 // and returns the matching values up to the limit, and a key in LastEvaluatedKey
38843884 // to apply in a subsequent operation to continue the operation. For more information,
38853885 // see Query and Scan in the Amazon DynamoDB Developer Guide.
3886 Limit *int64 `type:"integer"`
3886 Limit *int64 `min:"1" type:"integer"`
38873887
38883888 // A string that identifies one or more attributes to retrieve from the table.
38893889 // These attributes can include scalars, sets, or elements of a JSON document.
40334033 Select *string `type:"string" enum:"Select"`
40344034
40354035 // The name of the table containing the requested items.
4036 TableName *string `type:"string" required:"true"`
4036 TableName *string `min:"3" type:"string" required:"true"`
40374037
40384038 metadataQueryInput `json:"-" xml:"-"`
40394039 }
41314131 // Note that AttributesToGet has no effect on provisioned throughput consumption.
41324132 // DynamoDB determines capacity units consumed based on item size, not on the
41334133 // amount of data that is returned to an application.
4134 AttributesToGet []*string `type:"list"`
4134 AttributesToGet []*string `min:"1" type:"list"`
41354135
41364136 // This is a legacy parameter, for backward compatibility. New applications
41374137 // should use FilterExpression instead. Do not combine legacy parameters and
42584258 // The name of a secondary index to scan. This index can be any local secondary
42594259 // index or global secondary index. Note that if you use the IndexName parameter,
42604260 // you must also provide TableName.
4261 IndexName *string `type:"string"`
4261 IndexName *string `min:"3" type:"string"`
42624262
42634263 // The maximum number of items to evaluate (not necessarily the number of matching
42644264 // items). If DynamoDB processes the number of items up to the limit while processing
42694269 // and returns the matching values up to the limit, and a key in LastEvaluatedKey
42704270 // to apply in a subsequent operation to continue the operation. For more information,
42714271 // see Query and Scan in the Amazon DynamoDB Developer Guide.
4272 Limit *int64 `type:"integer"`
4272 Limit *int64 `min:"1" type:"integer"`
42734273
42744274 // A string that identifies one or more attributes to retrieve from the specified
42754275 // table or index. These attributes can include scalars, sets, or elements of
43884388
43894389 // The name of the table containing the requested items; or, if you provide
43904390 // IndexName, the name of the table to which that index belongs.
4391 TableName *string `type:"string" required:"true"`
4391 TableName *string `min:"3" type:"string" required:"true"`
43924392
43934393 // For a parallel Scan request, TotalSegments represents the total number of
43944394 // segments into which the Scan operation will be divided. The value of TotalSegments
44014401 // Scan operation will be sequential rather than parallel.
44024402 //
44034403 // If you specify TotalSegments, you must also specify Segment.
4404 TotalSegments *int64 `type:"integer"`
4404 TotalSegments *int64 `min:"1" type:"integer"`
44054405
44064406 metadataScanInput `json:"-" xml:"-"`
44074407 }
46154615 //
46164616 // For more information about primary keys, see Primary Key (http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html#DataModelPrimaryKey)
46174617 // in the Amazon DynamoDB Developer Guide.
4618 KeySchema []*KeySchemaElement `type:"list"`
4618 KeySchema []*KeySchemaElement `min:"1" type:"list"`
46194619
46204620 // The Amazon Resource Name (ARN) that uniquely identifies the latest stream
46214621 // for this table.
4622 LatestStreamArn *string `type:"string"`
4622 LatestStreamArn *string `min:"37" type:"string"`
46234623
46244624 // A timestamp, in ISO 8601 format, for this stream.
46254625 //
46904690 TableArn *string `type:"string"`
46914691
46924692 // The name of the table.
4693 TableName *string `type:"string"`
4693 TableName *string `min:"3" type:"string"`
46944694
46954695 // The total size of the specified table, in bytes. DynamoDB updates this value
46964696 // approximately every six hours. Recent changes might not be reflected in this
47294729 // secondary index.
47304730 type UpdateGlobalSecondaryIndexAction struct {
47314731 // The name of the global secondary index to be updated.
4732 IndexName *string `type:"string" required:"true"`
4732 IndexName *string `min:"3" type:"string" required:"true"`
47334733
47344734 // Represents the provisioned throughput settings for a specified table or index.
47354735 // The settings can be modified using the UpdateTable operation.
51925192 ReturnValues *string `type:"string" enum:"ReturnValue"`
51935193
51945194 // The name of the table containing the item to update.
5195 TableName *string `type:"string" required:"true"`
5195 TableName *string `min:"3" type:"string" required:"true"`
51965196
51975197 // An expression that defines one or more attributes to be updated, the action
51985198 // to be performed on them, and new value(s) for them.
53625362 StreamSpecification *StreamSpecification `type:"structure"`
53635363
53645364 // The name of the table to be updated.
5365 TableName *string `type:"string" required:"true"`
5365 TableName *string `min:"3" type:"string" required:"true"`
53665366
53675367 metadataUpdateTableInput `json:"-" xml:"-"`
53685368 }
+26
-26
service/dynamodbstreams/api.go less more
150150 type DescribeStreamInput struct {
151151 // The shard ID of the first item that this operation will evaluate. Use the
152152 // value that was returned for LastEvaluatedShardId in the previous operation.
153 ExclusiveStartShardId *string `type:"string"`
153 ExclusiveStartShardId *string `min:"28" type:"string"`
154154
155155 // The maximum number of shard objects to return. The upper limit is 100.
156 Limit *int64 `type:"integer"`
156 Limit *int64 `min:"1" type:"integer"`
157157
158158 // The Amazon Resource Name (ARN) for the stream.
159 StreamArn *string `type:"string" required:"true"`
159 StreamArn *string `min:"37" type:"string" required:"true"`
160160
161161 metadataDescribeStreamInput `json:"-" xml:"-"`
162162 }
204204 type GetRecordsInput struct {
205205 // The maximum number of records to return from the shard. The upper limit is
206206 // 1000.
207 Limit *int64 `type:"integer"`
207 Limit *int64 `min:"1" type:"integer"`
208208
209209 // A shard iterator that was retrieved from a previous GetShardIterator operation.
210210 // This iterator can be used to access the stream records in this shard.
211 ShardIterator *string `type:"string" required:"true"`
211 ShardIterator *string `min:"1" type:"string" required:"true"`
212212
213213 metadataGetRecordsInput `json:"-" xml:"-"`
214214 }
232232 // The next position in the shard from which to start sequentially reading stream
233233 // records. If set to null, the shard has been closed and the requested iterator
234234 // will not return any more data.
235 NextShardIterator *string `type:"string"`
235 NextShardIterator *string `min:"1" type:"string"`
236236
237237 // The stream records from the shard, which were retrieved using the shard iterator.
238238 Records []*Record `type:"list"`
257257 // Represents the input of a GetShardIterator operation.
258258 type GetShardIteratorInput struct {
259259 // The sequence number of a stream record in the shard from which to start reading.
260 SequenceNumber *string `type:"string"`
260 SequenceNumber *string `min:"21" type:"string"`
261261
262262 // The identifier of the shard. The iterator will be returned for this shard
263263 // ID.
264 ShardId *string `type:"string" required:"true"`
264 ShardId *string `min:"28" type:"string" required:"true"`
265265
266266 // Determines how the shard iterator is used to start reading stream records
267267 // from the shard:
282282 ShardIteratorType *string `type:"string" required:"true" enum:"ShardIteratorType"`
283283
284284 // The Amazon Resource Name (ARN) for the stream.
285 StreamArn *string `type:"string" required:"true"`
285 StreamArn *string `min:"37" type:"string" required:"true"`
286286
287287 metadataGetShardIteratorInput `json:"-" xml:"-"`
288288 }
306306 // The position in the shard from which to start reading stream records sequentially.
307307 // A shard iterator specifies this position using the sequence number of a stream
308308 // record in a shard.
309 ShardIterator *string `type:"string"`
309 ShardIterator *string `min:"1" type:"string"`
310310
311311 metadataGetShardIteratorOutput `json:"-" xml:"-"`
312312 }
330330 // The ARN (Amazon Resource Name) of the first item that this operation will
331331 // evaluate. Use the value that was returned for LastEvaluatedStreamArn in the
332332 // previous operation.
333 ExclusiveStartStreamArn *string `type:"string"`
333 ExclusiveStartStreamArn *string `min:"37" type:"string"`
334334
335335 // The maximum number of streams to return. The upper limit is 100.
336 Limit *int64 `type:"integer"`
336 Limit *int64 `min:"1" type:"integer"`
337337
338338 // If this parameter is provided, then only the streams associated with this
339339 // table name are returned.
340 TableName *string `type:"string"`
340 TableName *string `min:"3" type:"string"`
341341
342342 metadataListStreamsInput `json:"-" xml:"-"`
343343 }
368368 // If LastEvaluatedStreamArn is not empty, it does not necessarily mean that
369369 // there is more data in the result set. The only way to know when you have
370370 // reached the end of the result set is when LastEvaluatedStreamArn is empty.
371 LastEvaluatedStreamArn *string `type:"string"`
371 LastEvaluatedStreamArn *string `min:"37" type:"string"`
372372
373373 // A list of stream descriptors associated with the current account and endpoint.
374374 Streams []*Stream `type:"list"`
440440 // within a shard.
441441 type SequenceNumberRange struct {
442442 // The last sequence number.
443 EndingSequenceNumber *string `type:"string"`
443 EndingSequenceNumber *string `min:"21" type:"string"`
444444
445445 // The first sequence number.
446 StartingSequenceNumber *string `type:"string"`
446 StartingSequenceNumber *string `min:"21" type:"string"`
447447
448448 metadataSequenceNumberRange `json:"-" xml:"-"`
449449 }
465465 // A uniquely identified group of stream records within a stream.
466466 type Shard struct {
467467 // The shard ID of the current shard's parent.
468 ParentShardId *string `type:"string"`
468 ParentShardId *string `min:"28" type:"string"`
469469
470470 // The range of possible sequence numbers for the shard.
471471 SequenceNumberRange *SequenceNumberRange `type:"structure"`
472472
473473 // The system-generated identifier for this shard.
474 ShardId *string `type:"string"`
474 ShardId *string `min:"28" type:"string"`
475475
476476 metadataShard `json:"-" xml:"-"`
477477 }
493493 // Represents all of the data describing a particular stream.
494494 type Stream struct {
495495 // The Amazon Resource Name (ARN) for the stream.
496 StreamArn *string `type:"string"`
496 StreamArn *string `min:"37" type:"string"`
497497
498498 // A timestamp, in ISO 8601 format, for this stream.
499499 //
510510 StreamLabel *string `type:"string"`
511511
512512 // The DynamoDB table with which the stream is associated.
513 TableName *string `type:"string"`
513 TableName *string `min:"3" type:"string"`
514514
515515 metadataStream `json:"-" xml:"-"`
516516 }
535535 CreationRequestDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`
536536
537537 // The key attribute(s) of the stream's DynamoDB table.
538 KeySchema []*dynamodb.KeySchemaElement `type:"list"`
538 KeySchema []*dynamodb.KeySchemaElement `min:"1" type:"list"`
539539
540540 // The shard ID of the item where the operation stopped, inclusive of the previous
541541 // result set. Use this value to start a new operation, excluding this value
547547 // If LastEvaluatedShardId is not empty, it does not necessarily mean that
548548 // there is more data in the result set. The only way to know when you have
549549 // reached the end of the result set is when LastEvaluatedShardId is empty.
550 LastEvaluatedShardId *string `type:"string"`
550 LastEvaluatedShardId *string `min:"28" type:"string"`
551551
552552 // The shards that comprise the stream.
553553 Shards []*Shard `type:"list"`
554554
555555 // The Amazon Resource Name (ARN) for the stream.
556 StreamArn *string `type:"string"`
556 StreamArn *string `min:"37" type:"string"`
557557
558558 // A timestamp, in ISO 8601 format, for this stream.
559559 //
595595 StreamViewType *string `type:"string" enum:"StreamViewType"`
596596
597597 // The DynamoDB table with which the stream is associated.
598 TableName *string `type:"string"`
598 TableName *string `min:"3" type:"string"`
599599
600600 metadataStreamDescription `json:"-" xml:"-"`
601601 }
627627 OldImage map[string]*dynamodb.AttributeValue `type:"map"`
628628
629629 // The sequence number of the stream record.
630 SequenceNumber *string `type:"string"`
630 SequenceNumber *string `min:"21" type:"string"`
631631
632632 // The size of the stream record, in bytes.
633 SizeBytes *int64 `type:"long"`
633 SizeBytes *int64 `min:"1" type:"long"`
634634
635635 // The type of data from the modified DynamoDB item that was captured in this
636636 // stream record:
+139
-103
service/ec2/api.go less more
721721 return
722722 }
723723
724 // Cancels one or more Spot Instance requests. Spot Instances are instances
724 // Cancels one or more Spot instance requests. Spot instances are instances
725725 // that Amazon EC2 starts on your behalf when the bid price that you specify
726 // exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price
727 // based on available Spot Instance capacity and current Spot Instance requests.
726 // exceeds the current Spot price. Amazon EC2 periodically sets the Spot price
727 // based on available Spot instance capacity and current Spot instance requests.
728728 // For more information, see Spot Instance Requests (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html)
729729 // in the Amazon Elastic Compute Cloud User Guide.
730730 //
731 // Canceling a Spot Instance request does not terminate running Spot Instances
731 // Canceling a Spot instance request does not terminate running Spot instances
732732 // associated with the request.
733733 func (c *EC2) CancelSpotInstanceRequests(input *CancelSpotInstanceRequestsInput) (*CancelSpotInstanceRequestsOutput, error) {
734734 req, out := c.CancelSpotInstanceRequestsRequest(input)
15041504 return
15051505 }
15061506
1507 // Creates a data feed for Spot Instances, enabling you to view Spot Instance
1507 // Creates a data feed for Spot instances, enabling you to view Spot instance
15081508 // usage logs. You can create one data feed per AWS account. For more information,
15091509 // see Spot Instance Data Feed (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html)
15101510 // in the Amazon Elastic Compute Cloud User Guide.
22582258 return
22592259 }
22602260
2261 // Deletes the data feed for Spot Instances. For more information, see Spot
2262 // Instance Data Feed (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html)
2263 // in the Amazon Elastic Compute Cloud User Guide.
2261 // Deletes the data feed for Spot instances.
22642262 func (c *EC2) DeleteSpotDatafeedSubscription(input *DeleteSpotDatafeedSubscriptionInput) (*DeleteSpotDatafeedSubscriptionOutput, error) {
22652263 req, out := c.DeleteSpotDatafeedSubscriptionRequest(input)
22662264 err := req.Send()
37793777 return
37803778 }
37813779
3782 // Describes the data feed for Spot Instances. For more information, see Spot
3780 // Describes the data feed for Spot instances. For more information, see Spot
37833781 // Instance Data Feed (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html)
37843782 // in the Amazon Elastic Compute Cloud User Guide.
37853783 func (c *EC2) DescribeSpotDatafeedSubscription(input *DescribeSpotDatafeedSubscriptionInput) (*DescribeSpotDatafeedSubscriptionOutput, error) {
38943892 return
38953893 }
38963894
3897 // Describes the Spot Instance requests that belong to your account. Spot Instances
3895 // Describes the Spot instance requests that belong to your account. Spot instances
38983896 // are instances that Amazon EC2 launches when the bid price that you specify
3899 // exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price
3900 // based on available Spot Instance capacity and current Spot Instance requests.
3897 // exceeds the current Spot price. Amazon EC2 periodically sets the Spot price
3898 // based on available Spot instance capacity and current Spot instance requests.
39013899 // For more information, see Spot Instance Requests (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html)
39023900 // in the Amazon Elastic Compute Cloud User Guide.
39033901 //
3904 // You can use DescribeSpotInstanceRequests to find a running Spot Instance
3905 // by examining the response. If the status of the Spot Instance is fulfilled,
3902 // You can use DescribeSpotInstanceRequests to find a running Spot instance
3903 // by examining the response. If the status of the Spot instance is fulfilled,
39063904 // the instance ID appears in the response and contains the identifier of the
39073905 // instance. Alternatively, you can use DescribeInstances with a filter to look
39083906 // for instances where the instance lifecycle is spot.
39383936 return
39393937 }
39403938
3941 // Describes the Spot Price history. The prices returned are listed in chronological
3939 // Describes the Spot price history. The prices returned are listed in chronological
39423940 // order, from the oldest to the most recent, for up to the past 90 days. For
39433941 // more information, see Spot Instance Pricing History (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html)
39443942 // in the Amazon Elastic Compute Cloud User Guide.
57385736
57395737 // Creates a Spot fleet request.
57405738 //
5741 // You can submit a single request that specifies multiple instance types,
5742 // each with its own instance weighting that reflects its value to your application
5743 // workload. Amazon EC2 computes the bid price for each launch specification
5744 // and requests Spot Instances in the Spot pool where the price per unit is
5745 // the lowest. For more information, see Spot Fleets (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet.html)
5739 // You can submit a single request that includes multiple launch specifications
5740 // that vary by instance type, AMI, Availability Zone, or subnet.
5741 //
5742 // By default, the Spot fleet requests Spot instances in the Spot pool where
5743 // the price per unit is the lowest. Each launch specification can include its
5744 // own instance weighting that reflects the value of the instance type to your
5745 // application workload.
5746 //
5747 // Alternatively, you can specify that the Spot fleet distribute the target
5748 // capacity across the Spot pools included in its launch specifications. By
5749 // ensuring that the Spot instances in your Spot fleet are in different Spot
5750 // pools, you can improve the availability of your fleet.
5751 //
5752 // For more information, see Spot Fleet Requests (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html)
57465753 // in the Amazon Elastic Compute Cloud User Guide.
57475754 func (c *EC2) RequestSpotFleet(input *RequestSpotFleetInput) (*RequestSpotFleetOutput, error) {
57485755 req, out := c.RequestSpotFleetRequest(input)
57705777 return
57715778 }
57725779
5773 // Creates a Spot Instance request. Spot Instances are instances that Amazon
5780 // Creates a Spot instance request. Spot instances are instances that Amazon
57745781 // EC2 launches when the bid price that you specify exceeds the current Spot
5775 // Price. Amazon EC2 periodically sets the Spot Price based on available Spot
5776 // Instance capacity and current Spot Instance requests. For more information,
5782 // price. Amazon EC2 periodically sets the Spot price based on available Spot
5783 // Instance capacity and current Spot instance requests. For more information,
57775784 // see Spot Instance Requests (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html)
57785785 // in the Amazon Elastic Compute Cloud User Guide.
57795786 func (c *EC2) RequestSpotInstances(input *RequestSpotInstancesInput) (*RequestSpotInstancesOutput, error) {
63836390 // The instance type.
63846391 InstanceType *string `locationName:"instanceType" type:"string"`
63856392
6386 // The ID of the Spot Instance request.
6393 // The ID of the Spot instance request.
63876394 SpotInstanceRequestId *string `locationName:"spotInstanceRequestId" type:"string"`
63886395
63896396 metadataActiveInstance `json:"-" xml:"-"`
77997806 // it is UnauthorizedOperation.
78007807 DryRun *bool `locationName:"dryRun" type:"boolean"`
78017808
7802 // One or more Spot Instance request IDs.
7809 // One or more Spot instance request IDs.
78037810 SpotInstanceRequestIds []*string `locationName:"SpotInstanceRequestId" locationNameList:"SpotInstanceRequestId" type:"list" required:"true"`
78047811
78057812 metadataCancelSpotInstanceRequestsInput `json:"-" xml:"-"`
78217828
78227829 // Contains the output of CancelSpotInstanceRequests.
78237830 type CancelSpotInstanceRequestsOutput struct {
7824 // One or more Spot Instance requests.
7831 // One or more Spot instance requests.
78257832 CancelledSpotInstanceRequests []*CancelledSpotInstanceRequest `locationName:"spotInstanceRequestSet" locationNameList:"item" type:"list"`
78267833
78277834 metadataCancelSpotInstanceRequestsOutput `json:"-" xml:"-"`
78417848 return s.String()
78427849 }
78437850
7844 // Describes a request to cancel a Spot Instance.
7851 // Describes a request to cancel a Spot instance.
78457852 type CancelledSpotInstanceRequest struct {
7846 // The ID of the Spot Instance request.
7853 // The ID of the Spot instance request.
78477854 SpotInstanceRequestId *string `locationName:"spotInstanceRequestId" type:"string"`
78487855
7849 // The state of the Spot Instance request.
7856 // The state of the Spot instance request.
78507857 State *string `locationName:"state" type:"string" enum:"CancelSpotInstanceRequestState"`
78517858
78527859 metadataCancelledSpotInstanceRequest `json:"-" xml:"-"`
90919098
90929099 // Contains the parameters for CreateSpotDatafeedSubscription.
90939100 type CreateSpotDatafeedSubscriptionInput struct {
9094 // The Amazon S3 bucket in which to store the Spot Instance data feed.
9101 // The Amazon S3 bucket in which to store the Spot instance data feed.
90959102 Bucket *string `locationName:"bucket" type:"string" required:"true"`
90969103
90979104 // Checks whether you have the required permissions for the action, without
91229129
91239130 // Contains the output of CreateSpotDatafeedSubscription.
91249131 type CreateSpotDatafeedSubscriptionOutput struct {
9125 // The Spot Instance data feed subscription.
9132 // The Spot instance data feed subscription.
91269133 SpotDatafeedSubscription *SpotDatafeedSubscription `locationName:"spotDatafeedSubscription" type:"structure"`
91279134
91289135 metadataCreateSpotDatafeedSubscriptionOutput `json:"-" xml:"-"`
1352813535 // it is UnauthorizedOperation.
1352913536 DryRun *bool `locationName:"dryRun" type:"boolean"`
1353013537
13531 // One or more filters.
13538 // One or more filters. If using multiple filters for rules, the results include
13539 // security groups for which any combination of rules - not necessarily a single
13540 // rule - match all filters.
1353213541 //
1353313542 // description - The description of the security group.
1353413543 //
1382013829
1382113830 // Contains the output of DescribeSpotDatafeedSubscription.
1382213831 type DescribeSpotDatafeedSubscriptionOutput struct {
13823 // The Spot Instance data feed subscription.
13832 // The Spot instance data feed subscription.
1382413833 SpotDatafeedSubscription *SpotDatafeedSubscription `locationName:"spotDatafeedSubscription" type:"structure"`
1382513834
1382613835 metadataDescribeSpotDatafeedSubscriptionOutput `json:"-" xml:"-"`
1406014069 //
1406114070 // availability-zone-group - The Availability Zone group.
1406214071 //
14063 // create-time - The time stamp when the Spot Instance request was created.
14072 // create-time - The time stamp when the Spot instance request was created.
1406414073 //
1406514074 // fault-code - The fault code related to the request.
1406614075 //
1406814077 //
1406914078 // instance-id - The ID of the instance that fulfilled the request.
1407014079 //
14071 // launch-group - The Spot Instance launch group.
14080 // launch-group - The Spot instance launch group.
1407214081 //
1407314082 // launch.block-device-mapping.delete-on-termination - Indicates whether
1407414083 // the Amazon EBS volume is deleted on instance termination.
1409614105 // launch.key-name - The name of the key pair the instance launched with.
1409714106 //
1409814107 // launch.monitoring-enabled - Whether monitoring is enabled for the Spot
14099 // Instance.
14108 // instance.
1410014109 //
1410114110 // launch.ramdisk-id - The RAM disk ID.
1410214111 //
1412714136 // product-description - The product description associated with the instance
1412814137 // (Linux/UNIX | Windows).
1412914138 //
14130 // spot-instance-request-id - The Spot Instance request ID.
14131 //
14132 // spot-price - The maximum hourly price for any Spot Instance launched to
14139 // spot-instance-request-id - The Spot instance request ID.
14140 //
14141 // spot-price - The maximum hourly price for any Spot instance launched to
1413314142 // fulfill the request.
1413414143 //
14135 // state - The state of the Spot Instance request (open | active | closed
14144 // state - The state of the Spot instance request (open | active | closed
1413614145 // | cancelled | failed). Spot bid status information can help you track your
14137 // Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status
14146 // Amazon EC2 Spot instance requests. For more information, see Spot Bid Status
1413814147 // (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html)
1413914148 // in the Amazon Elastic Compute Cloud User Guide.
1414014149 //
1414114150 // status-code - The short code describing the most recent evaluation of
14142 // your Spot Instance request.
14143 //
14144 // status-message - The message explaining the status of the Spot Instance
14151 // your Spot instance request.
14152 //
14153 // status-message - The message explaining the status of the Spot instance
1414514154 // request.
1414614155 //
1414714156 // tag:key=value - The key/value combination of a tag assigned to the resource.
1415614165 // tag-value - The value of a tag assigned to the resource. This filter is
1415714166 // independent of the tag-key filter.
1415814167 //
14159 // type - The type of Spot Instance request (one-time | persistent).
14168 // type - The type of Spot instance request (one-time | persistent).
1416014169 //
1416114170 // launched-availability-zone - The Availability Zone in which the bid is
1416214171 // launched.
1416614175 // valid-until - The end date of the request.
1416714176 Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"`
1416814177
14169 // One or more Spot Instance request IDs.
14178 // One or more Spot instance request IDs.
1417014179 SpotInstanceRequestIds []*string `locationName:"SpotInstanceRequestId" locationNameList:"SpotInstanceRequestId" type:"list"`
1417114180
1417214181 metadataDescribeSpotInstanceRequestsInput `json:"-" xml:"-"`
1418814197
1418914198 // Contains the output of DescribeSpotInstanceRequests.
1419014199 type DescribeSpotInstanceRequestsOutput struct {
14191 // One or more Spot Instance requests.
14200 // One or more Spot instance requests.
1419214201 SpotInstanceRequests []*SpotInstanceRequest `locationName:"spotInstanceRequestSet" locationNameList:"item" type:"list"`
1419314202
1419414203 metadataDescribeSpotInstanceRequestsOutput `json:"-" xml:"-"`
1422914238 //
1423014239 // instance-type - The type of instance (for example, m1.small).
1423114240 //
14232 // product-description - The product description for the Spot Price (Linux/UNIX
14241 // product-description - The product description for the Spot price (Linux/UNIX
1423314242 // | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC)
1423414243 // | Windows (Amazon VPC)).
1423514244 //
14236 // spot-price - The Spot Price. The value must match exactly (or use wildcards;
14245 // spot-price - The Spot price. The value must match exactly (or use wildcards;
1423714246 // greater than or less than comparison is not supported).
1423814247 //
14239 // timestamp - The timestamp of the Spot Price history, in UTC format (for
14248 // timestamp - The timestamp of the Spot price history, in UTC format (for
1424014249 // example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater
1424114250 // than or less than comparison is not supported.
1424214251 Filters []*Filter `locationName:"Filter" locationNameList:"Filter" type:"list"`
1428214291 // when there are no more results to return.
1428314292 NextToken *string `locationName:"nextToken" type:"string"`
1428414293
14285 // The historical Spot Prices.
14294 // The historical Spot prices.
1428614295 SpotPriceHistory []*SpotPrice `locationName:"spotPriceHistorySet" locationNameList:"item" type:"list"`
1428714296
1428814297 metadataDescribeSpotPriceHistoryOutput `json:"-" xml:"-"`
1619816207 // For more information, see the description.
1619916208 //
1620016209 // spotInstanceCountLimitExceeded - You've reached the limit on the number
16201 // of Spot Instances that you can launch.
16210 // of Spot instances that you can launch.
1620216211 //
1620316212 // The following are the fleetRequestChange events.
1620416213 //
1620516214 // active - The Spot fleet has been validated and Amazon EC2 is attempting
16206 // to maintain the target number of running Spot Instances.
16207 //
16208 // cancelled - The Spot fleet is canceled and has no running Spot Instances.
16215 // to maintain the target number of running Spot instances.
16216 //
16217 // cancelled - The Spot fleet is canceled and has no running Spot instances.
1620916218 // The Spot fleet will be deleted two days after its instances were terminated.
1621016219 //
1621116220 // cancelled_running - The Spot fleet is canceled and will not launch additional
16212 // Spot Instances, but its existing Spot Instances will continue to run until
16213 // they are interrupted or terminated.
16214 //
16215 // cancelled_terminating - The Spot fleet is canceled and its Spot Instances
16221 // Spot instances, but its existing Spot instances continue to run until they
16222 // are interrupted or terminated.
16223 //
16224 // cancelled_terminating - The Spot fleet is canceled and its Spot instances
1621616225 // are terminating.
1621716226 //
1621816227 // expired - The Spot fleet request has expired. A subsequent event indicates
1622316232 // it was too high. This change is permanent.
1622416233 //
1622516234 // submitted - The Spot fleet request is being evaluated and Amazon EC2 is
16226 // preparing to launch the target number of Spot Instances.
16235 // preparing to launch the target number of Spot instances.
1622716236 //
1622816237 // The following are the instanceChange events.
1622916238 //
2043820447 // The user-specified name for a logical grouping of bids.
2043920448 //
2044020449 // When you specify an Availability Zone group in a Spot Instance request,
20441 // all Spot Instances in the request are launched in the same Availability Zone.
20450 // all Spot instances in the request are launched in the same Availability Zone.
2044220451 // Instance proximity is maintained with this parameter, but the choice of Availability
2044320452 // Zone is not. The group applies only to bids for Spot Instances of the same
20444 // instance type. Any additional Spot Instance requests that are specified with
20453 // instance type. Any additional Spot instance requests that are specified with
2044520454 // the same Availability Zone group name are launched in that same Availability
2044620455 // Zone, as long as at least one instance from the group is still active.
2044720456 //
2044820457 // If there is no active instance running in the Availability Zone group that
20449 // you specify for a new Spot Instance request (all instances are terminated,
20458 // you specify for a new Spot instance request (all instances are terminated,
2045020459 // the bid is expired, or the bid falls below current market), then Amazon EC2
2045120460 // launches the instance in any Availability Zone where the constraint can be
20452 // met. Consequently, the subsequent set of Spot Instances could be placed in
20461 // met. Consequently, the subsequent set of Spot instances could be placed in
2045320462 // a different zone from the original request, even if you specified the same
2045420463 // Availability Zone group.
2045520464 //
2046720476 // it is UnauthorizedOperation.
2046820477 DryRun *bool `locationName:"dryRun" type:"boolean"`
2046920478
20470 // The maximum number of Spot Instances to launch.
20479 // The maximum number of Spot instances to launch.
2047120480 //
2047220481 // Default: 1
2047320482 InstanceCount *int64 `locationName:"instanceCount" type:"integer"`
2047420483
20475 // The instance launch group. Launch groups are Spot Instances that launch together
20484 // The instance launch group. Launch groups are Spot instances that launch together
2047620485 // and terminate together.
2047720486 //
2047820487 // Default: Instances are launched and terminated individually
2048120490 // Describes the launch specification for an instance.
2048220491 LaunchSpecification *RequestSpotLaunchSpecification `type:"structure"`
2048320492
20484 // The maximum hourly price (bid) for any Spot Instance launched to fulfill
20493 // The maximum hourly price (bid) for any Spot instance launched to fulfill
2048520494 // the request.
2048620495 SpotPrice *string `locationName:"spotPrice" type:"string" required:"true"`
2048720496
20488 // The Spot Instance request type.
20497 // The Spot instance request type.
2048920498 //
2049020499 // Default: one-time
2049120500 Type *string `locationName:"type" type:"string" enum:"SpotInstanceType"`
2052620535
2052720536 // Contains the output of RequestSpotInstances.
2052820537 type RequestSpotInstancesOutput struct {
20529 // One or more Spot Instance requests.
20538 // One or more Spot instance requests.
2053020539 SpotInstanceRequests []*SpotInstanceRequest `locationName:"spotInstanceRequestSet" locationNameList:"item" type:"list"`
2053120540
2053220541 metadataRequestSpotInstancesOutput `json:"-" xml:"-"`
2177121780
2177221781 // Describes a snapshot.
2177321782 type Snapshot struct {
21783 // The data encryption key identifier for the snapshot. This value is a unique
21784 // identifier that corresponds to the data encryption key that was used to encrypt
21785 // the original volume or snapshot copy. Because data encryption keys are inherited
21786 // by volumes created from snapshots, and vice versa, if snapshots share the
21787 // same data encryption key identifier, then they belong to the same volume/snapshot
21788 // lineage. This parameter is only returned by the DescribeSnapshots API operation.
21789 DataEncryptionKeyId *string `locationName:"dataEncryptionKeyId" type:"string"`
21790
2177421791 // The description for the snapshot.
2177521792 Description *string `locationName:"description" type:"string"`
2177621793
2179221809 // The progress of the snapshot, as a percentage.
2179321810 Progress *string `locationName:"progress" type:"string"`
2179421811
21795 // The ID of the snapshot.
21812 // The ID of the snapshot. Each snapshot receives a unique identifier when it
21813 // is created.
2179621814 SnapshotId *string `locationName:"snapshotId" type:"string"`
2179721815
2179821816 // The time stamp when the snapshot was initiated.
2180121819 // The snapshot state.
2180221820 State *string `locationName:"status" type:"string" enum:"SnapshotState"`
2180321821
21822 // Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy
21823 // operation fails (for example, if the proper AWS Key Management Service (AWS
21824 // KMS) permissions are not obtained) this field displays error state details
21825 // to help you diagnose why the error occurred. This parameter is only returned
21826 // by the DescribeSnapshots API operation.
21827 StateMessage *string `locationName:"statusMessage" type:"string"`
21828
2180421829 // Any tags assigned to the snapshot.
2180521830 Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"`
2180621831
21807 // The ID of the volume.
21832 // The ID of the volume that was used to create the snapshot.
2180821833 VolumeId *string `locationName:"volumeId" type:"string"`
2180921834
2181021835 // The size of the volume, in GiB.
2195621981 return s.String()
2195721982 }
2195821983
21959 // Describes the data feed for a Spot Instance.
21984 // Describes the data feed for a Spot instance.
2196021985 type SpotDatafeedSubscription struct {
21961 // The Amazon S3 bucket where the Spot Instance data feed is located.
21986 // The Amazon S3 bucket where the Spot instance data feed is located.
2196221987 Bucket *string `locationName:"bucket" type:"string"`
2196321988
21964 // The fault codes for the Spot Instance request, if any.
21989 // The fault codes for the Spot instance request, if any.
2196521990 Fault *SpotInstanceStateFault `locationName:"fault" type:"structure"`
2196621991
2196721992 // The AWS account ID of the account.
2197021995 // The prefix that is prepended to data feed files.
2197121996 Prefix *string `locationName:"prefix" type:"string"`
2197221997
21973 // The state of the Spot Instance data feed subscription.
21998 // The state of the Spot instance data feed subscription.
2197421999 State *string `locationName:"state" type:"string" enum:"DatafeedSubscriptionState"`
2197522000
2197622001 metadataSpotDatafeedSubscription `json:"-" xml:"-"`
2199022015 return s.String()
2199122016 }
2199222017
21993 // Describes the launch specification for one or more Spot Instances.
22018 // Describes the launch specification for one or more Spot instances.
2199422019 type SpotFleetLaunchSpecification struct {
2199522020 // Deprecated.
2199622021 AddressingType *string `locationName:"addressingType" type:"string"`
2213222157
2213322158 // Describes the configuration of a Spot fleet request.
2213422159 type SpotFleetRequestConfigData struct {
22160 // Determines how to allocate the target capacity across the Spot pools specified
22161 // by the Spot fleet request. The default is lowestPrice.
22162 AllocationStrategy *string `locationName:"allocationStrategy" type:"string" enum:"AllocationStrategy"`
22163
2213522164 // A unique, case-sensitive identifier you provide to ensure idempotency of
2213622165 // your listings. This helps avoid duplicate listings. For more information,
2213722166 // see Ensuring Idempotency (http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).
2213822167 ClientToken *string `locationName:"clientToken" type:"string"`
2213922168
22140 // Grants the Spot fleet service permission to terminate instances on your behalf
22141 // when you cancel a Spot fleet request using CancelSpotFleetRequests or when
22169 // Grants the Spot fleet permission to terminate Spot instances on your behalf
22170 // when you cancel its Spot fleet request using CancelSpotFleetRequests or when
2214222171 // the Spot fleet request expires, if you set terminateInstancesWithExpiration.
2214322172 IamFleetRole *string `locationName:"iamFleetRole" type:"string" required:"true"`
2214422173
22145 // Information about the launch specifications for the instances.
22146 LaunchSpecifications []*SpotFleetLaunchSpecification `locationName:"launchSpecifications" locationNameList:"item" type:"list" required:"true"`
22174 // Information about the launch specifications for the Spot fleet request.
22175 LaunchSpecifications []*SpotFleetLaunchSpecification `locationName:"launchSpecifications" locationNameList:"item" min:"1" type:"list" required:"true"`
2214722176
2214822177 // The bid price per unit hour.
2214922178 SpotPrice *string `locationName:"spotPrice" type:"string" required:"true"`
2215322182 // your application workload, such as vCPUs, memory, or I/O.
2215422183 TargetCapacity *int64 `locationName:"targetCapacity" type:"integer" required:"true"`
2215522184
22156 // Indicates whether running instances should be terminated when the Spot fleet
22157 // request expires.
22185 // Indicates whether running Spot instances should be terminated when the Spot
22186 // fleet request expires.
2215822187 TerminateInstancesWithExpiration *bool `locationName:"terminateInstancesWithExpiration" type:"boolean"`
2215922188
2216022189 // The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
2216222191 ValidFrom *time.Time `locationName:"validFrom" type:"timestamp" timestampFormat:"iso8601"`
2216322192
2216422193 // The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
22165 // At this point, no new Spot Instance requests are placed or enabled to fulfill
22194 // At this point, no new Spot instance requests are placed or enabled to fulfill
2216622195 // the request.
2216722196 ValidUntil *time.Time `locationName:"validUntil" type:"timestamp" timestampFormat:"iso8601"`
2216822197
2218322212 return s.String()
2218422213 }
2218522214
22186 // Describe a Spot Instance request.
22215 // Describe a Spot instance request.
2218722216 type SpotInstanceRequest struct {
2218822217 // The Availability Zone group. If you specify the same Availability Zone group
22189 // for all Spot Instance requests, all Spot Instances are launched in the same
22218 // for all Spot instance requests, all Spot instances are launched in the same
2219022219 // Availability Zone.
2219122220 AvailabilityZoneGroup *string `locationName:"availabilityZoneGroup" type:"string"`
2219222221
22193 // The date and time when the Spot Instance request was created, in UTC format
22222 // The date and time when the Spot instance request was created, in UTC format
2219422223 // (for example, YYYY-MM-DDTHH:MM:SSZ).
2219522224 CreateTime *time.Time `locationName:"createTime" type:"timestamp" timestampFormat:"iso8601"`
2219622225
22197 // The fault codes for the Spot Instance request, if any.
22226 // The fault codes for the Spot instance request, if any.
2219822227 Fault *SpotInstanceStateFault `locationName:"fault" type:"structure"`
2219922228
22200 // The instance ID, if an instance has been launched to fulfill the Spot Instance
22229 // The instance ID, if an instance has been launched to fulfill the Spot instance
2220122230 // request.
2220222231 InstanceId *string `locationName:"instanceId" type:"string"`
2220322232
22204 // The instance launch group. Launch groups are Spot Instances that launch together
22233 // The instance launch group. Launch groups are Spot instances that launch together
2220522234 // and terminate together.
2220622235 LaunchGroup *string `locationName:"launchGroup" type:"string"`
2220722236
2221122240 // The Availability Zone in which the bid is launched.
2221222241 LaunchedAvailabilityZone *string `locationName:"launchedAvailabilityZone" type:"string"`
2221322242
22214 // The product description associated with the Spot Instance.
22243 // The product description associated with the Spot instance.
2221522244 ProductDescription *string `locationName:"productDescription" type:"string" enum:"RIProductDescription"`
2221622245
22217 // The ID of the Spot Instance request.
22246 // The ID of the Spot instance request.
2221822247 SpotInstanceRequestId *string `locationName:"spotInstanceRequestId" type:"string"`
2221922248
22220 // The maximum hourly price (bid) for any Spot Instance launched to fulfill
22249 // The maximum hourly price (bid) for any Spot instance launched to fulfill
2222122250 // the request.
2222222251 SpotPrice *string `locationName:"spotPrice" type:"string"`
2222322252
22224 // The state of the Spot Instance request. Spot bid status information can help
22225 // you track your Spot Instance requests. For more information, see Spot Bid
22253 // The state of the Spot instance request. Spot bid status information can help
22254 // you track your Spot instance requests. For more information, see Spot Bid
2222622255 // Status (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html)
2222722256 // in the Amazon Elastic Compute Cloud User Guide.
2222822257 State *string `locationName:"state" type:"string" enum:"SpotInstanceState"`
2222922258
22230 // The status code and status message describing the Spot Instance request.
22259 // The status code and status message describing the Spot instance request.
2223122260 Status *SpotInstanceStatus `locationName:"status" type:"structure"`
2223222261
2223322262 // Any tags assigned to the resource.
2223422263 Tags []*Tag `locationName:"tagSet" locationNameList:"item" type:"list"`
2223522264
22236 // The Spot Instance request type.
22265 // The Spot instance request type.
2223722266 Type *string `locationName:"type" type:"string" enum:"SpotInstanceType"`
2223822267
2223922268 // The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
2226622295 return s.String()
2226722296 }
2226822297
22269 // Describes a Spot Instance state change.
22298 // Describes a Spot instance state change.
2227022299 type SpotInstanceStateFault struct {
22271 // The reason code for the Spot Instance state change.
22300 // The reason code for the Spot instance state change.
2227222301 Code *string `locationName:"code" type:"string"`
2227322302
22274 // The message for the Spot Instance state change.
22303 // The message for the Spot instance state change.
2227522304 Message *string `locationName:"message" type:"string"`
2227622305
2227722306 metadataSpotInstanceStateFault `json:"-" xml:"-"`
2229122320 return s.String()
2229222321 }
2229322322
22294 // Describes the status of a Spot Instance request.
22323 // Describes the status of a Spot instance request.
2229522324 type SpotInstanceStatus struct {
2229622325 // The status code.
2229722326 Code *string `locationName:"code" type:"string"`
2232022349 return s.String()
2232122350 }
2232222351
22323 // Describes Spot Instance placement.
22352 // Describes Spot instance placement.
2232422353 type SpotPlacement struct {
2232522354 // The Availability Zone.
2232622355 AvailabilityZone *string `locationName:"availabilityZone" type:"string"`
2234522374 return s.String()
2234622375 }
2234722376
22348 // Describes the maximum hourly price (bid) for any Spot Instance launched to
22377 // Describes the maximum hourly price (bid) for any Spot instance launched to
2234922378 // fulfill the request.
2235022379 type SpotPrice struct {
2235122380 // The Availability Zone.
2235722386 // A general description of the AMI.
2235822387 ProductDescription *string `locationName:"productDescription" type:"string" enum:"RIProductDescription"`
2235922388
22360 // The maximum price (bid) that you are willing to pay for a Spot Instance.
22389 // The maximum price (bid) that you are willing to pay for a Spot instance.
2236122390 SpotPrice *string `locationName:"spotPrice" type:"string"`
2236222391
2236322392 // The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
2366123690 AccountAttributeNameSupportedPlatforms = "supported-platforms"
2366223691 // @enum AccountAttributeName
2366323692 AccountAttributeNameDefaultVpc = "default-vpc"
23693 )
23694
23695 const (
23696 // @enum AllocationStrategy
23697 AllocationStrategyLowestPrice = "lowestPrice"
23698 // @enum AllocationStrategy
23699 AllocationStrategyDiversified = "diversified"
2366423700 )
2366523701
2366623702 const (
+1
-0
service/ec2/examples_test.go less more
46204620 },
46214621 SpotPrice: aws.String("String"), // Required
46224622 TargetCapacity: aws.Int64(1), // Required
4623 AllocationStrategy: aws.String("AllocationStrategy"),
46234624 ClientToken: aws.String("String"),
46244625 TerminateInstancesWithExpiration: aws.Bool(true),
46254626 ValidFrom: aws.Time(time.Now()),
+27
-20
service/efs/api.go less more
112112 // when mounting the file system. The EC2 instance on which you mount the file
113113 // system via the mount target can resolve the mount target's DNS name to its
114114 // IP address. For more information, see How it Works: Implementation Overview
115 // (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation)
115 // (http://docs.aws.amazon.com/efs/latest/ug/how-it-works.html#how-it-works-implementation).
116116 //
117117 // Note that you can create mount targets for a file system in only one VPC,
118118 // and there can be only one mount target per Availability Zone. That is, if
152152 // in another Availability Zone. For more information, go to Amazon EFS (http://aws.amazon.com/efs/)
153153 // product detail page. In addition, by always using a mount target local to
154154 // the instance's Availability Zone, you eliminate a partial failure scenario;
155 // if the Availablity Zone in which your mount target is created goes down,
155 // if the Availability Zone in which your mount target is created goes down,
156156 // then you won't be able to access your file system through that mount target.
157157 //
158158 // This operation requires permission for the following action on the file
159159 // system:
160160 //
161 // elasticfilesystem:CreateMountTarget This operation also requires permission
161 // elasticfilesystem:CreateMountTarget This operation also requires permission
162162 // for the following Amazon EC2 actions:
163163 //
164 // ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
164 // ec2:DescribeSubnets ec2:DescribeNetworkInterfaces ec2:CreateNetworkInterface
165165 func (c *EFS) CreateMountTarget(input *CreateMountTargetInput) (*MountTargetDescription, error) {
166166 req, out := c.CreateMountTargetRequest(input)
167167 err := req.Send()
276276 // This operation requires permission for the following action on the file
277277 // system:
278278 //
279 // elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns
279 // elasticfilesystem:DeleteMountTarget The DeleteMountTarget call returns
280280 // while the mount target state is still "deleting". You can check the mount
281281 // target deletion by calling the DescribeMountTargets API, which returns a
282282 // list of mount target descriptions for the given file system. The operation
283283 // also requires permission for the following Amazon EC2 action on the mount
284284 // target's network interface:
285285 //
286 // ec2:DeleteNetworkInterface
286 // ec2:DeleteNetworkInterface
287287 func (c *EFS) DeleteMountTarget(input *DeleteMountTargetInput) (*DeleteMountTargetOutput, error) {
288288 req, out := c.DeleteMountTargetRequest(input)
289289 err := req.Send()
431431 return
432432 }
433433
434 // Returns the descriptions of the current mount targets for a file system.
435 // The order of mount targets returned in the response is unspecified.
436 //
437 // This operation requires permission for the elasticfilesystem:DescribeMountTargets
438 // action on the file system FileSystemId.
434 // Returns the descriptions of all the current mount targets, or a specific
435 // mount target, for a file system. When requesting all of the current mount
436 // targets, the order of mount targets returned in the response is unspecified.
437 //
438 // This operation requires permission for the elasticfilesystem:DescribeMountTargets
439 // action, on either the file system id that you specify in FileSystemId, or
440 // on the file system of the mount target that you specify in MountTargetId.
439441 func (c *EFS) DescribeMountTargets(input *DescribeMountTargetsInput) (*DescribeMountTargetsOutput, error) {
440442 req, out := c.DescribeMountTargetsRequest(input)
441443 err := req.Send()
518520 type CreateFileSystemInput struct {
519521 // String of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent
520522 // creation.
521 CreationToken *string `type:"string" required:"true"`
523 CreationToken *string `min:"1" type:"string" required:"true"`
522524
523525 metadataCreateFileSystemInput `json:"-" xml:"-"`
524526 }
735737 // Optional string. Restricts the list to the file system with this creation
736738 // token (you specify a creation token at the time of creating an Amazon EFS
737739 // file system).
738 CreationToken *string `location:"querystring" locationName:"CreationToken" type:"string"`
740 CreationToken *string `location:"querystring" locationName:"CreationToken" min:"1" type:"string"`
739741
740742 // Optional string. File system ID whose description you want to retrieve.
741743 FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`
750752 // of items Amazon EFS returns will be the minimum of the MaxItems parameter
751753 // specified in the request and the service's internal maximum number of items
752754 // per page.
753 MaxItems *int64 `location:"querystring" locationName:"MaxItems" type:"integer"`
755 MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
754756
755757 metadataDescribeFileSystemsInput `json:"-" xml:"-"`
756758 }
840842 }
841843
842844 type DescribeMountTargetsInput struct {
843 // String. The ID of the file system whose mount targets you want to list.
844 FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string" required:"true"`
845 // Optional. String. The ID of the file system whose mount targets you want
846 // to list. It must be included in your request if MountTargetId is not included.
847 FileSystemId *string `location:"querystring" locationName:"FileSystemId" type:"string"`
845848
846849 // Optional. String. Opaque pagination token returned from a previous DescribeMountTargets
847850 // operation. If present, it specifies to continue the list from where the previous
850853
851854 // Optional. Maximum number of mount targets to return in the response. It must
852855 // be an integer with a value greater than zero.
853 MaxItems *int64 `location:"querystring" locationName:"MaxItems" type:"integer"`
856 MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
857
858 // Optional. String. The ID of the mount target that you want to have described.
859 // It must be included in your request if FileSystemId is not included.
860 MountTargetId *string `location:"querystring" locationName:"MountTargetId" type:"string"`
854861
855862 metadataDescribeMountTargetsInput `json:"-" xml:"-"`
856863 }
911918
912919 // Optional. Maximum number of file system tags to return in the response. It
913920 // must be an integer with a value greater than zero.
914 MaxItems *int64 `location:"querystring" locationName:"MaxItems" type:"integer"`
921 MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
915922
916923 metadataDescribeTagsInput `json:"-" xml:"-"`
917924 }
966973 CreationTime *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"`
967974
968975 // Opaque string specified in the request.
969 CreationToken *string `type:"string" required:"true"`
976 CreationToken *string `min:"1" type:"string" required:"true"`
970977
971978 // The file system ID assigned by Amazon EFS.
972979 FileSystemId *string `type:"string" required:"true"`
11371144 // '+', '-', '=', '.', '_', ':', and '/'.
11381145 type Tag struct {
11391146 // Tag key, a string. The key must not start with "aws:".
1140 Key *string `type:"string" required:"true"`
1147 Key *string `min:"1" type:"string" required:"true"`
11411148
11421149 // Value of the tag key.
11431150 Value *string `type:"string" required:"true"`
+4
-3
service/efs/examples_test.go less more
189189 svc := efs.New(nil)
190190
191191 params := &efs.DescribeMountTargetsInput{
192 FileSystemId: aws.String("FileSystemId"), // Required
193 Marker: aws.String("Marker"),
194 MaxItems: aws.Int64(1),
192 FileSystemId: aws.String("FileSystemId"),
193 Marker: aws.String("Marker"),
194 MaxItems: aws.Int64(1),
195 MountTargetId: aws.String("MountTargetId"),
195196 }
196197 resp, err := svc.DescribeMountTargets(params)
197198
+81
-81
service/elasticbeanstalk/api.go less more
996996
997997 // This specifies the name of the environment with the in-progress update that
998998 // you want to cancel.
999 EnvironmentName *string `type:"string"`
999 EnvironmentName *string `min:"4" type:"string"`
10001000
10011001 metadataAbortEnvironmentUpdateInput `json:"-" xml:"-"`
10021002 }
10361036 // Describes the properties of an application.
10371037 type ApplicationDescription struct {
10381038 // The name of the application.
1039 ApplicationName *string `type:"string"`
1039 ApplicationName *string `min:"1" type:"string"`
10401040
10411041 // The names of the configuration templates associated with this application.
10421042 ConfigurationTemplates []*string `type:"list"`
11311131 // Describes the properties of an application version.
11321132 type ApplicationVersionDescription struct {
11331133 // The name of the application associated with this release.
1134 ApplicationName *string `type:"string"`
1134 ApplicationName *string `min:"1" type:"string"`
11351135
11361136 // The creation date of the application version.
11371137 DateCreated *time.Time `type:"timestamp" timestampFormat:"iso8601"`
11461146 SourceBundle *S3Location `type:"structure"`
11471147
11481148 // A label uniquely identifying the version for the associated application.
1149 VersionLabel *string `type:"string"`
1149 VersionLabel *string `min:"1" type:"string"`
11501150
11511151 metadataApplicationVersionDescription `json:"-" xml:"-"`
11521152 }
12611261 // Results message indicating whether a CNAME is available.
12621262 type CheckDNSAvailabilityInput struct {
12631263 // The prefix used when this CNAME is reserved.
1264 CNAMEPrefix *string `type:"string" required:"true"`
1264 CNAMEPrefix *string `min:"4" type:"string" required:"true"`
12651265
12661266 metadataCheckDNSAvailabilityInput `json:"-" xml:"-"`
12671267 }
12931293
12941294 // The fully qualified CNAME to reserve when CreateEnvironment is called with
12951295 // the provided prefix.
1296 FullyQualifiedCNAME *string `type:"string"`
1296 FullyQualifiedCNAME *string `min:"1" type:"string"`
12971297
12981298 metadataCheckDNSAvailabilityOutput `json:"-" xml:"-"`
12991299 }
14331433 OptionName *string `type:"string"`
14341434
14351435 // A unique resource name for a time-based scaling configuration option.
1436 ResourceName *string `type:"string"`
1436 ResourceName *string `min:"1" type:"string"`
14371437
14381438 // The current value for the configuration option.
14391439 Value *string `type:"string"`
14581458 // Describes the settings for a configuration set.
14591459 type ConfigurationSettingsDescription struct {
14601460 // The name of the application associated with this configuration set.
1461 ApplicationName *string `type:"string"`
1461 ApplicationName *string `min:"1" type:"string"`
14621462
14631463 // The date (in UTC time) when this configuration set was created.
14641464 DateCreated *time.Time `type:"timestamp" timestampFormat:"iso8601"`
14901490 Description *string `type:"string"`
14911491
14921492 // If not null, the name of the environment for this configuration set.
1493 EnvironmentName *string `type:"string"`
1493 EnvironmentName *string `min:"4" type:"string"`
14941494
14951495 // A list of the configuration options and their values in this configuration
14961496 // set.
15011501
15021502 // If not null, the name of the configuration template for this configuration
15031503 // set.
1504 TemplateName *string `type:"string"`
1504 TemplateName *string `min:"1" type:"string"`
15051505
15061506 metadataConfigurationSettingsDescription `json:"-" xml:"-"`
15071507 }
15261526 //
15271527 // Constraint: This name must be unique within your account. If the specified
15281528 // name already exists, the action returns an InvalidParameterValue error.
1529 ApplicationName *string `type:"string" required:"true"`
1529 ApplicationName *string `min:"1" type:"string" required:"true"`
15301530
15311531 // Describes the application.
15321532 Description *string `type:"string"`
15511551 type CreateApplicationVersionInput struct {
15521552 // The name of the application. If no application is found with this name, and
15531553 // AutoCreateApplication is false, returns an InvalidParameterValue error.
1554 ApplicationName *string `type:"string" required:"true"`
1554 ApplicationName *string `min:"1" type:"string" required:"true"`
15551555
15561556 // Determines how the system behaves if the specified application for this version
15571557 // does not already exist:
15911591 // Constraint: Must be unique per application. If an application version already
15921592 // exists with this label for the specified application, AWS Elastic Beanstalk
15931593 // returns an InvalidParameterValue error.
1594 VersionLabel *string `type:"string" required:"true"`
1594 VersionLabel *string `min:"1" type:"string" required:"true"`
15951595
15961596 metadataCreateApplicationVersionInput `json:"-" xml:"-"`
15971597 }
16151615 // The name of the application to associate with this configuration template.
16161616 // If no application is found with this name, AWS Elastic Beanstalk returns
16171617 // an InvalidParameterValue error.
1618 ApplicationName *string `type:"string" required:"true"`
1618 ApplicationName *string `min:"1" type:"string" required:"true"`
16191619
16201620 // Describes this configuration.
16211621 Description *string `type:"string"`
16651665 //
16661666 // Default: If a configuration template already exists with this name, AWS
16671667 // Elastic Beanstalk returns an InvalidParameterValue error.
1668 TemplateName *string `type:"string" required:"true"`
1668 TemplateName *string `min:"1" type:"string" required:"true"`
16691669
16701670 metadataCreateConfigurationTemplateInput `json:"-" xml:"-"`
16711671 }
16891689 //
16901690 // If no application is found with this name, CreateEnvironment returns an
16911691 // InvalidParameterValue error.
1692 ApplicationName *string `type:"string" required:"true"`
1692 ApplicationName *string `min:"1" type:"string" required:"true"`
16931693
16941694 // If specified, the environment attempts to use this value as the prefix for
16951695 // the CNAME. If not specified, the CNAME is generated automatically by appending
16961696 // a random alphanumeric string to the environment name.
1697 CNAMEPrefix *string `type:"string"`
1697 CNAMEPrefix *string `min:"4" type:"string"`
16981698
16991699 // Describes this environment.
17001700 Description *string `type:"string"`
17081708 //
17091709 // Default: If the CNAME parameter is not specified, the environment name becomes
17101710 // part of the CNAME, and therefore part of the visible URL for your application.
1711 EnvironmentName *string `type:"string" required:"true"`
1711 EnvironmentName *string `min:"4" type:"string" required:"true"`
17121712
17131713 // If specified, AWS Elastic Beanstalk sets the specified configuration options
17141714 // to the requested value in the configuration set for the new environment.
17411741 // but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
17421742 // error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
17431743 // error.
1744 TemplateName *string `type:"string"`
1744 TemplateName *string `min:"1" type:"string"`
17451745
17461746 // This specifies the tier to use for creating this environment.
17471747 Tier *EnvironmentTier `type:"structure"`
17531753 //
17541754 // Default: If not specified, AWS Elastic Beanstalk attempts to launch the
17551755 // sample application in the container.
1756 VersionLabel *string `type:"string"`
1756 VersionLabel *string `min:"1" type:"string"`
17571757
17581758 metadataCreateEnvironmentInput `json:"-" xml:"-"`
17591759 }
18151815 // This documentation target is not reported in the API reference.
18161816 type DeleteApplicationInput struct {
18171817 // The name of the application to delete.
1818 ApplicationName *string `type:"string" required:"true"`
1818 ApplicationName *string `min:"1" type:"string" required:"true"`
18191819
18201820 // When set to true, running environments will be terminated before deleting
18211821 // the application.
18591859 // This documentation target is not reported in the API reference.
18601860 type DeleteApplicationVersionInput struct {
18611861 // The name of the application to delete releases from.
1862 ApplicationName *string `type:"string" required:"true"`
1862 ApplicationName *string `min:"1" type:"string" required:"true"`
18631863
18641864 // Indicates whether to delete the associated source bundle from Amazon S3:
18651865 //
18691869 DeleteSourceBundle *bool `type:"boolean"`
18701870
18711871 // The label of the version to delete.
1872 VersionLabel *string `type:"string" required:"true"`
1872 VersionLabel *string `min:"1" type:"string" required:"true"`
18731873
18741874 metadataDeleteApplicationVersionInput `json:"-" xml:"-"`
18751875 }
19091909 // This documentation target is not reported in the API reference.
19101910 type DeleteConfigurationTemplateInput struct {
19111911 // The name of the application to delete the configuration template from.
1912 ApplicationName *string `type:"string" required:"true"`
1912 ApplicationName *string `min:"1" type:"string" required:"true"`
19131913
19141914 // The name of the configuration template to delete.
1915 TemplateName *string `type:"string" required:"true"`
1915 TemplateName *string `min:"1" type:"string" required:"true"`
19161916
19171917 metadataDeleteConfigurationTemplateInput `json:"-" xml:"-"`
19181918 }
19521952 // This documentation target is not reported in the API reference.
19531953 type DeleteEnvironmentConfigurationInput struct {
19541954 // The name of the application the environment is associated with.
1955 ApplicationName *string `type:"string" required:"true"`
1955 ApplicationName *string `min:"1" type:"string" required:"true"`
19561956
19571957 // The name of the environment to delete the draft configuration from.
1958 EnvironmentName *string `type:"string" required:"true"`
1958 EnvironmentName *string `min:"4" type:"string" required:"true"`
19591959
19601960 metadataDeleteEnvironmentConfigurationInput `json:"-" xml:"-"`
19611961 }
19961996 type DescribeApplicationVersionsInput struct {
19971997 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
19981998 // only include ones that are associated with the specified application.
1999 ApplicationName *string `type:"string"`
1999 ApplicationName *string `min:"1" type:"string"`
20002000
20012001 // If specified, restricts the returned descriptions to only include ones that
20022002 // have the specified version labels.
20912091 // The name of the application associated with the configuration template or
20922092 // environment. Only needed if you want to describe the configuration options
20932093 // associated with either the configuration template or environment.
2094 ApplicationName *string `type:"string"`
2094 ApplicationName *string `min:"1" type:"string"`
20952095
20962096 // The name of the environment whose configuration options you want to describe.
2097 EnvironmentName *string `type:"string"`
2097 EnvironmentName *string `min:"4" type:"string"`
20982098
20992099 // If specified, restricts the descriptions to only the specified options.
21002100 Options []*OptionSpecification `type:"list"`
21042104
21052105 // The name of the configuration template whose configuration options you want
21062106 // to describe.
2107 TemplateName *string `type:"string"`
2107 TemplateName *string `min:"1" type:"string"`
21082108
21092109 metadataDescribeConfigurationOptionsInput `json:"-" xml:"-"`
21102110 }
21522152 // solution stack or configuration template.
21532153 type DescribeConfigurationSettingsInput struct {
21542154 // The application for the environment or configuration template.
2155 ApplicationName *string `type:"string" required:"true"`
2155 ApplicationName *string `min:"1" type:"string" required:"true"`
21562156
21572157 // The name of the environment to describe.
21582158 //
21602160 // If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
21612161 // error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
21622162 // error.
2163 EnvironmentName *string `type:"string"`
2163 EnvironmentName *string `min:"4" type:"string"`
21642164
21652165 // The name of the configuration template to describe.
21662166 //
21682168 // but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination
21692169 // error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter
21702170 // error.
2171 TemplateName *string `type:"string"`
2171 TemplateName *string `min:"1" type:"string"`
21722172
21732173 metadataDescribeConfigurationSettingsInput `json:"-" xml:"-"`
21742174 }
22192219 EnvironmentId *string `type:"string"`
22202220
22212221 // Specifies the AWS Elastic Beanstalk environment name.
2222 EnvironmentName *string `type:"string"`
2222 EnvironmentName *string `min:"4" type:"string"`
22232223
22242224 metadataDescribeEnvironmentHealthInput `json:"-" xml:"-"`
22252225 }
22512251 Color *string `type:"string"`
22522252
22532253 // The AWS Elastic Beanstalk environment name.
2254 EnvironmentName *string `type:"string"`
2254 EnvironmentName *string `min:"4" type:"string"`
22552255
22562256 // Contains the response body with information about the health of the environment.
22572257 HealthStatus *string `type:"string"`
22982298 // Condition: You must specify either this or an EnvironmentId, or both. If
22992299 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
23002300 // error.
2301 EnvironmentName *string `type:"string"`
2301 EnvironmentName *string `min:"4" type:"string"`
23022302
23032303 metadataDescribeEnvironmentResourcesInput `json:"-" xml:"-"`
23042304 }
23432343 type DescribeEnvironmentsInput struct {
23442344 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
23452345 // include only those that are associated with this application.
2346 ApplicationName *string `type:"string"`
2346 ApplicationName *string `min:"1" type:"string"`
23472347
23482348 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
23492349 // include only those that have the specified IDs.
23672367
23682368 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
23692369 // include only those that are associated with this application version.
2370 VersionLabel *string `type:"string"`
2370 VersionLabel *string `min:"1" type:"string"`
23712371
23722372 metadataDescribeEnvironmentsInput `json:"-" xml:"-"`
23732373 }
24122412 type DescribeEventsInput struct {
24132413 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
24142414 // include only those associated with this application.
2415 ApplicationName *string `type:"string"`
2415 ApplicationName *string `min:"1" type:"string"`
24162416
24172417 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
24182418 // those that occur up to, but not including, the EndTime.
24242424
24252425 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
24262426 // those associated with this environment.
2427 EnvironmentName *string `type:"string"`
2427 EnvironmentName *string `min:"4" type:"string"`
24282428
24292429 // Specifies the maximum number of events that can be returned, beginning with
24302430 // the most recent event.
2431 MaxRecords *int64 `type:"integer"`
2431 MaxRecords *int64 `min:"1" type:"integer"`
24322432
24332433 // Pagination token. If specified, the events return the next batch of results.
24342434 NextToken *string `type:"string"`
24472447
24482448 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
24492449 // those that are associated with this environment configuration.
2450 TemplateName *string `type:"string"`
2450 TemplateName *string `min:"1" type:"string"`
24512451
24522452 // If specified, AWS Elastic Beanstalk restricts the returned descriptions to
24532453 // those associated with this application version.
2454 VersionLabel *string `type:"string"`
2454 VersionLabel *string `min:"1" type:"string"`
24552455
24562456 metadataDescribeEventsInput `json:"-" xml:"-"`
24572457 }
25062506 EnvironmentId *string `type:"string"`
25072507
25082508 // Specifies the AWS Elastic Beanstalk environment name.
2509 EnvironmentName *string `type:"string"`
2509 EnvironmentName *string `min:"4" type:"string"`
25102510
25112511 // Specifies the next token of the request.
2512 NextToken *string `type:"string"`
2512 NextToken *string `min:"1" type:"string"`
25132513
25142514 metadataDescribeInstancesHealthInput `json:"-" xml:"-"`
25152515 }
25342534 InstanceHealthList []*SingleInstanceHealth `type:"list"`
25352535
25362536 // The next token.
2537 NextToken *string `type:"string"`
2537 NextToken *string `min:"1" type:"string"`
25382538
25392539 // The date and time the information was last refreshed.
25402540 RefreshedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
25672567 AbortableOperationInProgress *bool `type:"boolean"`
25682568
25692569 // The name of the application associated with this environment.
2570 ApplicationName *string `type:"string"`
2570 ApplicationName *string `min:"1" type:"string"`
25712571
25722572 // The URL to the CNAME for this environment.
2573 CNAME *string `type:"string"`
2573 CNAME *string `min:"1" type:"string"`
25742574
25752575 // The creation date for this environment.
25762576 DateCreated *time.Time `type:"timestamp" timestampFormat:"iso8601"`
25892589 EnvironmentId *string `type:"string"`
25902590
25912591 // The name of this environment.
2592 EnvironmentName *string `type:"string"`
2592 EnvironmentName *string `min:"4" type:"string"`
25932593
25942594 // Describes the health status of the environment. AWS Elastic Beanstalk indicates
25952595 // the failure levels for a running environment:
26302630 Status *string `type:"string" enum:"EnvironmentStatus"`
26312631
26322632 // The name of the configuration template used to originally launch this environment.
2633 TemplateName *string `type:"string"`
2633 TemplateName *string `min:"1" type:"string"`
26342634
26352635 // Describes the current tier of this environment.
26362636 Tier *EnvironmentTier `type:"structure"`
26372637
26382638 // The application version deployed in this environment.
2639 VersionLabel *string `type:"string"`
2639 VersionLabel *string `min:"1" type:"string"`
26402640
26412641 metadataEnvironmentDescription `json:"-" xml:"-"`
26422642 }
26922692 AutoScalingGroups []*AutoScalingGroup `type:"list"`
26932693
26942694 // The name of the environment.
2695 EnvironmentName *string `type:"string"`
2695 EnvironmentName *string `min:"4" type:"string"`
26962696
26972697 // The Amazon EC2 instances used by this environment.
26982698 Instances []*Instance `type:"list"`
27802780 // Describes an event.
27812781 type EventDescription struct {
27822782 // The application associated with the event.
2783 ApplicationName *string `type:"string"`
2783 ApplicationName *string `min:"1" type:"string"`
27842784
27852785 // The name of the environment associated with this event.
2786 EnvironmentName *string `type:"string"`
2786 EnvironmentName *string `min:"4" type:"string"`
27872787
27882788 // The date when the event occurred.
27892789 EventDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
27982798 Severity *string `type:"string" enum:"EventSeverity"`
27992799
28002800 // The name of the configuration associated with this event.
2801 TemplateName *string `type:"string"`
2801 TemplateName *string `min:"1" type:"string"`
28022802
28032803 // The release label for the application version associated with this event.
2804 VersionLabel *string `type:"string"`
2804 VersionLabel *string `min:"1" type:"string"`
28052805
28062806 metadataEventDescription `json:"-" xml:"-"`
28072807 }
31203120 OptionName *string `type:"string"`
31213121
31223122 // A unique resource name for a time-based scaling configuration option.
3123 ResourceName *string `type:"string"`
3123 ResourceName *string `min:"1" type:"string"`
31243124
31253125 metadataOptionSpecification `json:"-" xml:"-"`
31263126 }
31773177 // Condition: You must specify either this or an EnvironmentId, or both. If
31783178 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
31793179 // error.
3180 EnvironmentName *string `type:"string"`
3180 EnvironmentName *string `min:"4" type:"string"`
31813181
31823182 metadataRebuildEnvironmentInput `json:"-" xml:"-"`
31833183 }
32343234 // Condition: You must specify either this or an EnvironmentId, or both. If
32353235 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
32363236 // error.
3237 EnvironmentName *string `type:"string"`
3237 EnvironmentName *string `min:"4" type:"string"`
32383238
32393239 // The type of information to request.
32403240 InfoType *string `type:"string" required:"true" enum:"EnvironmentInfoType"`
32873287 // Condition: You must specify either this or an EnvironmentId, or both. If
32883288 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
32893289 // error.
3290 EnvironmentName *string `type:"string"`
3290 EnvironmentName *string `min:"4" type:"string"`
32913291
32923292 metadataRestartAppServerInput `json:"-" xml:"-"`
32933293 }
33423342 // Condition: You must specify either this or an EnvironmentId, or both. If
33433343 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
33443344 // error.
3345 EnvironmentName *string `type:"string"`
3345 EnvironmentName *string `min:"4" type:"string"`
33463346
33473347 // The type of information to retrieve.
33483348 InfoType *string `type:"string" required:"true" enum:"EnvironmentInfoType"`
34323432 HealthStatus *string `type:"string"`
34333433
34343434 // The ID of the Amazon EC2 instance.
3435 InstanceId *string `type:"string"`
3435 InstanceId *string `min:"1" type:"string"`
34363436
34373437 // The time at which the EC2 instance was launched.
34383438 LaunchedAt *time.Time `type:"timestamp" timestampFormat:"iso8601"`
34863486 // A specification for an environment configuration
34873487 type SourceConfiguration struct {
34883488 // The name of the application associated with the configuration.
3489 ApplicationName *string `type:"string"`
3489 ApplicationName *string `min:"1" type:"string"`
34903490
34913491 // The name of the configuration template.
3492 TemplateName *string `type:"string"`
3492 TemplateName *string `min:"1" type:"string"`
34933493
34943494 metadataSourceConfiguration `json:"-" xml:"-"`
34953495 }
35593559 // Condition: You must specify at least the DestinationEnvironmentID or the
35603560 // DestinationEnvironmentName. You may also specify both. You must specify the
35613561 // SourceEnvironmentName with the DestinationEnvironmentName.
3562 DestinationEnvironmentName *string `type:"string"`
3562 DestinationEnvironmentName *string `min:"4" type:"string"`
35633563
35643564 // The ID of the source environment.
35653565 //
35733573 // Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName.
35743574 // You may also specify both. If you specify the SourceEnvironmentName, you
35753575 // must specify the DestinationEnvironmentName.
3576 SourceEnvironmentName *string `type:"string"`
3576 SourceEnvironmentName *string `min:"4" type:"string"`
35773577
35783578 metadataSwapEnvironmentCNAMEsInput `json:"-" xml:"-"`
35793579 }
36423642 // Describes a tag applied to a resource in an environment.
36433643 type Tag struct {
36443644 // The key of the tag.
3645 Key *string `type:"string"`
3645 Key *string `min:"1" type:"string"`
36463646
36473647 // The value of the tag.
3648 Value *string `type:"string"`
3648 Value *string `min:"1" type:"string"`
36493649
36503650 metadataTag `json:"-" xml:"-"`
36513651 }
36783678 // Condition: You must specify either this or an EnvironmentId, or both. If
36793679 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
36803680 // error.
3681 EnvironmentName *string `type:"string"`
3681 EnvironmentName *string `min:"4" type:"string"`
36823682
36833683 // Indicates whether the associated AWS resources should shut down when the
36843684 // environment is terminated:
37433743 type UpdateApplicationInput struct {
37443744 // The name of the application to update. If no such application is found, UpdateApplication
37453745 // returns an InvalidParameterValue error.
3746 ApplicationName *string `type:"string" required:"true"`
3746 ApplicationName *string `min:"1" type:"string" required:"true"`
37473747
37483748 // A new description for the application.
37493749 //
37723772 //
37733773 // If no application is found with this name, UpdateApplication returns an
37743774 // InvalidParameterValue error.
3775 ApplicationName *string `type:"string" required:"true"`
3775 ApplicationName *string `min:"1" type:"string" required:"true"`
37763776
37773777 // A new description for this release.
37783778 Description *string `type:"string"`
37813781 //
37823782 // If no application version is found with this label, UpdateApplication returns
37833783 // an InvalidParameterValue error.
3784 VersionLabel *string `type:"string" required:"true"`
3784 VersionLabel *string `min:"1" type:"string" required:"true"`
37853785
37863786 metadataUpdateApplicationVersionInput `json:"-" xml:"-"`
37873787 }
38073807 //
38083808 // If no application is found with this name, UpdateConfigurationTemplate
38093809 // returns an InvalidParameterValue error.
3810 ApplicationName *string `type:"string" required:"true"`
3810 ApplicationName *string `min:"1" type:"string" required:"true"`
38113811
38123812 // A new description for the configuration.
38133813 Description *string `type:"string"`
38253825 //
38263826 // If no configuration template is found with this name, UpdateConfigurationTemplate
38273827 // returns an InvalidParameterValue error.
3828 TemplateName *string `type:"string" required:"true"`
3828 TemplateName *string `min:"1" type:"string" required:"true"`
38293829
38303830 metadataUpdateConfigurationTemplateInput `json:"-" xml:"-"`
38313831 }
38663866 // Condition: You must specify either this or an EnvironmentId, or both. If
38673867 // you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter
38683868 // error.
3869 EnvironmentName *string `type:"string"`
3869 EnvironmentName *string `min:"4" type:"string"`
38703870
38713871 // If specified, AWS Elastic Beanstalk updates the configuration set associated
38723872 // with the running environment and sets the specified configuration options
38843884 // If this parameter is specified, AWS Elastic Beanstalk deploys this configuration
38853885 // template to the environment. If no such configuration template is found,
38863886 // AWS Elastic Beanstalk returns an InvalidParameterValue error.
3887 TemplateName *string `type:"string"`
3887 TemplateName *string `min:"1" type:"string"`
38883888
38893889 // This specifies the tier to use to update the environment.
38903890 //
38953895 // If this parameter is specified, AWS Elastic Beanstalk deploys the named application
38963896 // version to the environment. If no such application version is found, returns
38973897 // an InvalidParameterValue error.
3898 VersionLabel *string `type:"string"`
3898 VersionLabel *string `min:"1" type:"string"`
38993899
39003900 metadataUpdateEnvironmentInput `json:"-" xml:"-"`
39013901 }
39183918 type ValidateConfigurationSettingsInput struct {
39193919 // The name of the application that the configuration template or environment
39203920 // belongs to.
3921 ApplicationName *string `type:"string" required:"true"`
3921 ApplicationName *string `min:"1" type:"string" required:"true"`
39223922
39233923 // The name of the environment to validate the settings against.
39243924 //
39253925 // Condition: You cannot specify both this and a configuration template name.
3926 EnvironmentName *string `type:"string"`
3926 EnvironmentName *string `min:"4" type:"string"`
39273927
39283928 // A list of the options and desired values to evaluate.
39293929 OptionSettings []*ConfigurationOptionSetting `type:"list" required:"true"`
39313931 // The name of the configuration template to validate the settings against.
39323932 //
39333933 // Condition: You cannot specify both this and an environment name.
3934 TemplateName *string `type:"string"`
3934 TemplateName *string `min:"1" type:"string"`
39353935
39363936 metadataValidateConfigurationSettingsInput `json:"-" xml:"-"`
39373937 }
+21
-21
service/elastictranscoder/api.go less more
601601 // If the file name includes a prefix, for example, cooking/pie.jpg, include
602602 // the prefix in the key. If the file isn't in the specified bucket, Elastic
603603 // Transcoder returns an error.
604 InputKey *string `type:"string"`
604 InputKey *string `min:"1" type:"string"`
605605
606606 // The maximum height of the output album art in pixels. If you specify auto,
607607 // Elastic Transcoder uses 600 as the default value. If you specify a numeric
978978
979979 // The name of the sidecar caption file that you want Elastic Transcoder to
980980 // include in the output file.
981 Key *string `type:"string"`
981 Key *string `min:"1" type:"string"`
982982
983983 // The label of the caption shown in the player when choosing a language. We
984984 // recommend that you put the caption language name here, in the language of
985985 // the captions.
986 Label *string `type:"string"`
986 Label *string `min:"1" type:"string"`
987987
988988 // A string that specifies the language of the caption. Specify this as one
989989 // of:
994994 //
995995 // For more information on ISO language codes and language names, see the
996996 // List of ISO 639-1 codes.
997 Language *string `type:"string"`
997 Language *string `min:"1" type:"string"`
998998
999999 // For clip generation or captions that do not start at the same time as the
10001000 // associated video file, the TimeOffset tells Elastic Transcoder how much of
11021102 // The value, if any, that you want Elastic Transcoder to prepend to the names
11031103 // of all files that this job creates, including output files, thumbnails, and
11041104 // playlists.
1105 OutputKeyPrefix *string `type:"string"`
1105 OutputKeyPrefix *string `min:"1" type:"string"`
11061106
11071107 // A section of the request body that provides information about the transcoded
11081108 // (target) files. We recommend that you use the Outputs syntax instead of the
12141214 // in the Amazon S3 bucket specified by the OutputBucket object in the pipeline
12151215 // that is specified by the pipeline ID. If a file with the specified name already
12161216 // exists in the output bucket, the job fails.
1217 Key *string `type:"string"`
1217 Key *string `min:"1" type:"string"`
12181218
12191219 // The Id of the preset to use for this job. The preset determines the audio,
12201220 // video, and thumbnail settings that Elastic Transcoder uses for transcoding.
13221322 // to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc
13231323 // for Smooth playlists). If you include a file extension in Name, the file
13241324 // name will have two extensions.
1325 Name *string `type:"string"`
1325 Name *string `min:"1" type:"string"`
13261326
13271327 // For each output in this job that you want to include in a master playlist,
13281328 // the value of the Outputs:Key object.
14741474 // AWS account, but uniqueness is not enforced.
14751475 //
14761476 // Constraints: Maximum 40 characters.
1477 Name *string `type:"string" required:"true"`
1477 Name *string `min:"1" type:"string" required:"true"`
14781478
14791479 // The Amazon Simple Notification Service (Amazon SNS) topic that you want to
14801480 // notify to report job status.
16231623
16241624 // The name of the preset. We recommend that the name be unique within the AWS
16251625 // account, but uniqueness is not enforced.
1626 Name *string `type:"string" required:"true"`
1626 Name *string `min:"1" type:"string" required:"true"`
16271627
16281628 // A section of the request body that specifies the thumbnail parameters, if
16291629 // any.
19691969 // of all files that this job creates, including output files, thumbnails, and
19701970 // playlists. We recommend that you add a / or some other delimiter to the end
19711971 // of the OutputKeyPrefix.
1972 OutputKeyPrefix *string `type:"string"`
1972 OutputKeyPrefix *string `min:"1" type:"string"`
19731973
19741974 // Information about the output files. We recommend that you use the Outputs
19751975 // syntax for all jobs, even when you want Elastic Transcoder to transcode a
21262126 // If the file name includes a prefix, such as cooking/lasagna.mpg, include
21272127 // the prefix in the key. If the file isn't in the specified bucket, Elastic
21282128 // Transcoder returns an error.
2129 Key *string `type:"string"`
2129 Key *string `min:"1" type:"string"`
21302130
21312131 // This value must be auto, which causes Elastic Transcoder to automatically
21322132 // detect the resolution of the input file.
22432243 // The name to assign to the transcoded file. Elastic Transcoder saves the file
22442244 // in the Amazon S3 bucket specified by the OutputBucket object in the pipeline
22452245 // that is specified by the pipeline ID.
2246 Key *string `type:"string"`
2246 Key *string `min:"1" type:"string"`
22472247
22482248 // The value of the Id object for the preset that you want to use for this job.
22492249 // The preset determines the audio, video, and thumbnail settings that Elastic
23832383 // If the file name includes a prefix, for example, logos/128x64.png, include
23842384 // the prefix in the key. If the file isn't in the specified bucket, Elastic
23852385 // Transcoder returns an error.
2386 InputKey *string `type:"string"`
2386 InputKey *string `min:"1" type:"string"`
23872387
23882388 // The ID of the watermark settings that Elastic Transcoder uses to add watermarks
23892389 // to the video during transcoding. The settings are in the preset specified
23902390 // by Preset for the current output. In that preset, the value of Watermarks
23912391 // Id tells Elastic Transcoder which settings to use.
2392 PresetWatermarkId *string `type:"string"`
2392 PresetWatermarkId *string `min:"1" type:"string"`
23932393
23942394 metadataJobWatermark `json:"-" xml:"-"`
23952395 }
26902690 // ID for an AWS account, an origin access identity for a CloudFront distribution,
26912691 // the registered email address of an AWS account, or a predefined Amazon S3
26922692 // group.
2693 Grantee *string `type:"string"`
2693 Grantee *string `min:"1" type:"string"`
26942694
26952695 // The type of value that appears in the Grantee object: Canonical: Either
26962696 // the canonical user ID for an AWS account or an origin access identity for
27722772 // AWS account, but uniqueness is not enforced.
27732773 //
27742774 // Constraints: Maximum 40 characters
2775 Name *string `type:"string"`
2775 Name *string `min:"1" type:"string"`
27762776
27772777 // The Amazon Simple Notification Service (Amazon SNS) topic that you want to
27782778 // notify to report job status.
29472947 // header is referenced in the protection header of the client manifest for
29482948 // Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata
29492949 // tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/
2950 LicenseAcquisitionUrl *string `type:"string"`
2950 LicenseAcquisitionUrl *string `min:"1" type:"string"`
29512951
29522952 metadataPlayReadyDrm `json:"-" xml:"-"`
29532953 }
29902990 // to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc
29912991 // for Smooth playlists). If you include a file extension in Name, the file
29922992 // name will have two extensions.
2993 Name *string `type:"string"`
2993 Name *string `min:"1" type:"string"`
29942994
29952995 // For each output in this job that you want to include in a master playlist,
29962996 // the value of the Outputs:Key object.
30843084 Id *string `type:"string"`
30853085
30863086 // The name of the preset.
3087 Name *string `type:"string"`
3087 Name *string `min:"1" type:"string"`
30883088
30893089 // A section of the response body that provides information about the thumbnail
30903090 // preset values, if any.
31583158
31593159 // A unique identifier for the settings for one watermark. The value of Id can
31603160 // be up to 40 characters long.
3161 Id *string `type:"string"`
3161 Id *string `min:"1" type:"string"`
31623162
31633163 // The maximum height of the watermark in one of the following formats: number
31643164 // of pixels (px): The minimum value is 16 pixels, and the maximum value is
36843684 // AWS account, but uniqueness is not enforced.
36853685 //
36863686 // Constraints: Maximum 40 characters
3687 Name *string `type:"string"`
3687 Name *string `min:"1" type:"string"`
36883688
36893689 // The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify
36903690 // in order to report job status.
+15
-15
service/elb/api.go less more
10031003 LoadBalancerNames []*string `type:"list" required:"true"`
10041004
10051005 // The tags.
1006 Tags []*Tag `type:"list" required:"true"`
1006 Tags []*Tag `min:"1" type:"list" required:"true"`
10071007
10081008 metadataAddTagsInput `json:"-" xml:"-"`
10091009 }
11861186 // Information about the configuration of a back-end server.
11871187 type BackendServerDescription struct {
11881188 // The port on which the back-end server is listening.
1189 InstancePort *int64 `type:"integer"`
1189 InstancePort *int64 `min:"1" type:"integer"`
11901190
11911191 // The names of the policies enabled for the back-end server.
11921192 PolicyNames []*string `type:"list"`
12831283 type ConnectionSettings struct {
12841284 // The time, in seconds, that the connection is allowed to be idle (no data
12851285 // has been sent over the connection) before it is closed by the load balancer.
1286 IdleTimeout *int64 `type:"integer" required:"true"`
1286 IdleTimeout *int64 `min:"1" type:"integer" required:"true"`
12871287
12881288 metadataConnectionSettings `json:"-" xml:"-"`
12891289 }
14421442 //
14431443 // For more information about tagging your load balancer, see Tagging (http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#tagging-elb)
14441444 // in the Elastic Load Balancing Developer Guide.
1445 Tags []*Tag `type:"list"`
1445 Tags []*Tag `min:"1" type:"list"`
14461446
14471447 metadataCreateLoadBalancerInput `json:"-" xml:"-"`
14481448 }
19491949
19501950 // The maximum number of results to return with this call (a number from 1 to
19511951 // 400). The default is 400.
1952 PageSize *int64 `type:"integer"`
1952 PageSize *int64 `min:"1" type:"integer"`
19531953
19541954 metadataDescribeLoadBalancersInput `json:"-" xml:"-"`
19551955 }
19951995
19961996 type DescribeTagsInput struct {
19971997 // The names of the load balancers.
1998 LoadBalancerNames []*string `type:"list" required:"true"`
1998 LoadBalancerNames []*string `min:"1" type:"list" required:"true"`
19991999
20002000 metadataDescribeTagsInput `json:"-" xml:"-"`
20012001 }
21742174 type HealthCheck struct {
21752175 // The number of consecutive health checks successes required before moving
21762176 // the instance to the Healthy state.
2177 HealthyThreshold *int64 `type:"integer" required:"true"`
2177 HealthyThreshold *int64 `min:"2" type:"integer" required:"true"`
21782178
21792179 // The approximate interval, in seconds, between health checks of an individual
21802180 // instance.
2181 Interval *int64 `type:"integer" required:"true"`
2181 Interval *int64 `min:"1" type:"integer" required:"true"`
21822182
21832183 // The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL.
21842184 // The range of valid ports is one (1) through 65535.
22042204 // check.
22052205 //
22062206 // This value must be less than the Interval value.
2207 Timeout *int64 `type:"integer" required:"true"`
2207 Timeout *int64 `min:"1" type:"integer" required:"true"`
22082208
22092209 // The number of consecutive health check failures required before moving the
22102210 // instance to the Unhealthy state.
2211 UnhealthyThreshold *int64 `type:"integer" required:"true"`
2211 UnhealthyThreshold *int64 `min:"2" type:"integer" required:"true"`
22122212
22132213 metadataHealthCheck `json:"-" xml:"-"`
22142214 }
23482348 // in the Elastic Load Balancing Developer Guide.
23492349 type Listener struct {
23502350 // The port on which the instance is listening.
2351 InstancePort *int64 `type:"integer" required:"true"`
2351 InstancePort *int64 `min:"1" type:"integer" required:"true"`
23522352
23532353 // The protocol to use for routing traffic to back-end instances: HTTP, HTTPS,
23542354 // TCP, or SSL.
28282828 LoadBalancerNames []*string `type:"list" required:"true"`
28292829
28302830 // The list of tag keys to remove.
2831 Tags []*TagKeyOnly `type:"list" required:"true"`
2831 Tags []*TagKeyOnly `min:"1" type:"list" required:"true"`
28322832
28332833 metadataRemoveTagsInput `json:"-" xml:"-"`
28342834 }
30303030 // Information about a tag.
30313031 type Tag struct {
30323032 // The key of the tag.
3033 Key *string `type:"string" required:"true"`
3033 Key *string `min:"1" type:"string" required:"true"`
30343034
30353035 // The value of the tag.
30363036 Value *string `type:"string"`
30583058 LoadBalancerName *string `type:"string"`
30593059
30603060 // The tags.
3061 Tags []*Tag `type:"list"`
3061 Tags []*Tag `min:"1" type:"list"`
30623062
30633063 metadataTagDescription `json:"-" xml:"-"`
30643064 }
30803080 // The key of a tag.
30813081 type TagKeyOnly struct {
30823082 // The name of the key.
3083 Key *string `type:"string"`
3083 Key *string `min:"1" type:"string"`
30843084
30853085 metadataTagKeyOnly `json:"-" xml:"-"`
30863086 }
+7
-7
service/emr/api.go less more
14821482 InstanceGroupType *string `type:"string" enum:"InstanceGroupType"`
14831483
14841484 // The EC2 instance type for all instances in the instance group.
1485 InstanceType *string `type:"string"`
1485 InstanceType *string `min:"1" type:"string"`
14861486
14871487 // The marketplace to provision instances for this group. Valid values are ON_DEMAND
14881488 // or SPOT.
15371537 InstanceRole *string `type:"string" required:"true" enum:"InstanceRoleType"`
15381538
15391539 // The Amazon EC2 instance type for all instances in the instance group.
1540 InstanceType *string `type:"string" required:"true"`
1540 InstanceType *string `min:"1" type:"string" required:"true"`
15411541
15421542 // Market type of the Amazon EC2 instances used to create a cluster node.
15431543 Market *string `type:"string" enum:"MarketType"`
15871587 InstanceRunningCount *int64 `type:"integer" required:"true"`
15881588
15891589 // Amazon EC2 Instance type.
1590 InstanceType *string `type:"string" required:"true"`
1590 InstanceType *string `min:"1" type:"string" required:"true"`
15911591
15921592 // Details regarding the state of the instance group.
15931593 LastStateChangeReason *string `type:"string"`
19731973 KeepJobFlowAliveWhenNoSteps *bool `type:"boolean"`
19741974
19751975 // The EC2 instance type of the master node.
1976 MasterInstanceType *string `type:"string"`
1976 MasterInstanceType *string `min:"1" type:"string"`
19771977
19781978 // The Availability Zone the job flow will run in.
19791979 Placement *PlacementType `type:"structure"`
19801980
19811981 // The EC2 instance type of the slave nodes.
1982 SlaveInstanceType *string `type:"string"`
1982 SlaveInstanceType *string `min:"1" type:"string"`
19831983
19841984 // Specifies whether to lock the job flow to prevent the Amazon EC2 instances
19851985 // from being terminated by API call, user intervention, or in the event of
20312031 MasterInstanceId *string `type:"string"`
20322032
20332033 // The Amazon EC2 master node instance type.
2034 MasterInstanceType *string `type:"string" required:"true"`
2034 MasterInstanceType *string `min:"1" type:"string" required:"true"`
20352035
20362036 // The DNS name of the master node.
20372037 MasterPublicDnsName *string `type:"string"`
20482048 Placement *PlacementType `type:"structure"`
20492049
20502050 // The Amazon EC2 slave node instance type.
2051 SlaveInstanceType *string `type:"string" required:"true"`
2051 SlaveInstanceType *string `min:"1" type:"string" required:"true"`
20522052
20532053 // Specifies whether the Amazon EC2 instances in the cluster are protected from
20542054 // termination by API calls, user intervention, or in the event of a job flow
+1289
-491
service/iam/api.go less more
124124 //
125125 // For more information about policies, refer to Managed Policies and Inline
126126 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
127 // in the Using IAM guide.
127 // in the IAM User Guide.
128128 func (c *IAM) AttachGroupPolicy(input *AttachGroupPolicyInput) (*AttachGroupPolicyOutput, error) {
129129 req, out := c.AttachGroupPolicyRequest(input)
130130 err := req.Send()
162162 // Use this API to attach a managed policy to a role. To embed an inline policy
163163 // in a role, use PutRolePolicy. For more information about policies, refer
164164 // to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
165 // in the Using IAM guide.
165 // in the IAM User Guide.
166166 func (c *IAM) AttachRolePolicy(input *AttachRolePolicyInput) (*AttachRolePolicyOutput, error) {
167167 req, out := c.AttachRolePolicyRequest(input)
168168 err := req.Send()
196196 //
197197 // For more information about policies, refer to Managed Policies and Inline
198198 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
199 // in the Using IAM guide.
199 // in the IAM User Guide.
200200 func (c *IAM) AttachUserPolicy(input *AttachUserPolicyInput) (*AttachUserPolicyOutput, error) {
201201 req, out := c.AttachUserPolicyRequest(input)
202202 err := req.Send()
228228 //
229229 // To change the password for a different user, see UpdateLoginProfile. For
230230 // more information about modifying passwords, see Managing Passwords (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html)
231 // in the Using IAM guide.
231 // in the IAM User Guide.
232232 func (c *IAM) ChangePassword(input *ChangePasswordInput) (*ChangePasswordOutput, error) {
233233 req, out := c.ChangePasswordRequest(input)
234234 err := req.Send()
265265 //
266266 // For information about limits on the number of keys you can create, see
267267 // Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
268 // in the Using IAM guide.
268 // in the IAM User Guide.
269269 //
270270 // To ensure the security of your AWS account, the secret access key is accessible
271271 // only during key and user creation. You must save the key (for example, in
300300
301301 // Creates an alias for your AWS account. For information about using an AWS
302302 // account alias, see Using an Alias for Your AWS Account ID (http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html)
303 // in the Using IAM guide.
303 // in the IAM User Guide.
304304 func (c *IAM) CreateAccountAlias(input *CreateAccountAliasInput) (*CreateAccountAliasOutput, error) {
305305 req, out := c.CreateAccountAliasRequest(input)
306306 err := req.Send()
331331 //
332332 // For information about the number of groups you can create, see Limitations
333333 // on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
334 // in the Using IAM guide.
334 // in the IAM User Guide.
335335 func (c *IAM) CreateGroup(input *CreateGroupInput) (*CreateGroupOutput, error) {
336336 req, out := c.CreateGroupRequest(input)
337337 err := req.Send()
363363 //
364364 // For information about the number of instance profiles you can create, see
365365 // Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
366 // in the Using IAM guide.
366 // in the IAM User Guide.
367367 func (c *IAM) CreateInstanceProfile(input *CreateInstanceProfileInput) (*CreateInstanceProfileOutput, error) {
368368 req, out := c.CreateInstanceProfileRequest(input)
369369 err := req.Send()
468468 // This operation creates a policy version with a version identifier of v1
469469 // and sets v1 as the policy's default version. For more information about policy
470470 // versions, see Versioning for Managed Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
471 // in the Using IAM guide.
471 // in the IAM User Guide.
472472 //
473473 // For more information about managed policies in general, refer to Managed
474474 // Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
475 // in the Using IAM guide.
475 // in the IAM User Guide.
476476 func (c *IAM) CreatePolicy(input *CreatePolicyInput) (*CreatePolicyOutput, error) {
477477 req, out := c.CreatePolicyRequest(input)
478478 err := req.Send()
511511 //
512512 // For more information about managed policy versions, see Versioning for Managed
513513 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
514 // in the Using IAM guide.
514 // in the IAM User Guide.
515515 func (c *IAM) CreatePolicyVersion(input *CreatePolicyVersionInput) (*CreatePolicyVersionOutput, error) {
516516 req, out := c.CreatePolicyVersionRequest(input)
517517 err := req.Send()
542542 // go to Working with Roles (http://docs.aws.amazon.com/IAM/latest/UserGuide/WorkingWithRoles.html).
543543 // For information about limitations on role names and the number of roles you
544544 // can create, go to Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
545 // in the Using IAM guide.
545 // in the IAM User Guide.
546546 //
547547 // The policy in the following example grants permission to an EC2 instance
548548 // to assume the role.
589589 // your organization's IdP.
590590 //
591591 // This operation requires Signature Version 4 (http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).
592 // For more information, see Giving Console Access Using SAML (http://docs.aws.amazon.com/STS/latest/UsingSTS/STSMgmtConsole-SAML.html)
593 // and Creating Temporary Security Credentials for SAML Federation (http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html)
594 // in the Using Temporary Credentials guide.
592 // For more information, see Enabling SAML 2.0 Federated Users to Access the
593 // AWS Management Console (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_enable-console-saml.html)
594 // and About SAML 2.0-based Federation (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html)
595 // in the IAM User Guide.
595596 func (c *IAM) CreateSAMLProvider(input *CreateSAMLProviderInput) (*CreateSAMLProviderOutput, error) {
596597 req, out := c.CreateSAMLProviderRequest(input)
597598 err := req.Send()
622623 //
623624 // For information about limitations on the number of users you can create,
624625 // see Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
625 // in the Using IAM guide.
626 // in the IAM User Guide.
626627 func (c *IAM) CreateUser(input *CreateUserInput) (*CreateUserOutput, error) {
627628 req, out := c.CreateUserRequest(input)
628629 err := req.Send()
755756
756757 // Deletes the specified AWS account alias. For information about using an AWS
757758 // account alias, see Using an Alias for Your AWS Account ID (http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html)
758 // in the Using IAM guide.
759 // in the IAM User Guide.
759760 func (c *IAM) DeleteAccountAlias(input *DeleteAccountAliasInput) (*DeleteAccountAliasOutput, error) {
760761 req, out := c.DeleteAccountAliasRequest(input)
761762 err := req.Send()
842843 // A group can also have managed policies attached to it. To detach a managed
843844 // policy from a group, use DetachGroupPolicy. For more information about policies,
844845 // refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
845 // in the Using IAM guide.
846 // in the IAM User Guide.
846847 func (c *IAM) DeleteGroupPolicy(input *DeleteGroupPolicyInput) (*DeleteGroupPolicyOutput, error) {
847848 req, out := c.DeleteGroupPolicyRequest(input)
848849 err := req.Send()
987988 //
988989 // For information about managed policies, refer to Managed Policies and Inline
989990 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
990 // in the Using IAM guide.
991 // in the IAM User Guide.
991992 func (c *IAM) DeletePolicy(input *DeletePolicyInput) (*DeletePolicyOutput, error) {
992993 req, out := c.DeletePolicyRequest(input)
993994 err := req.Send()
10221023 //
10231024 // For information about versions for managed policies, refer to Versioning
10241025 // for Managed Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
1025 // in the Using IAM guide.
1026 // in the IAM User Guide.
10261027 func (c *IAM) DeletePolicyVersion(input *DeletePolicyVersionInput) (*DeletePolicyVersionOutput, error) {
10271028 req, out := c.DeletePolicyVersionRequest(input)
10281029 err := req.Send()
10861087 // A role can also have managed policies attached to it. To detach a managed
10871088 // policy from a role, use DetachRolePolicy. For more information about policies,
10881089 // refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1089 // in the Using IAM guide.
1090 // in the IAM User Guide.
10901091 func (c *IAM) DeleteRolePolicy(input *DeleteRolePolicyInput) (*DeleteRolePolicyOutput, error) {
10911092 req, out := c.DeleteRolePolicyRequest(input)
10921093 err := req.Send()
12811282 // A user can also have managed policies attached to it. To detach a managed
12821283 // policy from a user, use DetachUserPolicy. For more information about policies,
12831284 // refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1284 // in the Using IAM guide.
1285 // in the IAM User Guide.
12851286 func (c *IAM) DeleteUserPolicy(input *DeleteUserPolicyInput) (*DeleteUserPolicyOutput, error) {
12861287 req, out := c.DeleteUserPolicyRequest(input)
12871288 err := req.Send()
13431344 // A group can also have inline policies embedded with it. To delete an inline
13441345 // policy, use the DeleteGroupPolicy API. For information about policies, refer
13451346 // to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1346 // in the Using IAM guide.
1347 // in the IAM User Guide.
13471348 func (c *IAM) DetachGroupPolicy(input *DetachGroupPolicyInput) (*DetachGroupPolicyOutput, error) {
13481349 req, out := c.DetachGroupPolicyRequest(input)
13491350 err := req.Send()
13751376 // A role can also have inline policies embedded with it. To delete an inline
13761377 // policy, use the DeleteRolePolicy API. For information about policies, refer
13771378 // to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1378 // in the Using IAM guide.
1379 // in the IAM User Guide.
13791380 func (c *IAM) DetachRolePolicy(input *DetachRolePolicyInput) (*DetachRolePolicyOutput, error) {
13801381 req, out := c.DetachRolePolicyRequest(input)
13811382 err := req.Send()
14071408 // A user can also have inline policies embedded with it. To delete an inline
14081409 // policy, use the DeleteUserPolicy API. For information about policies, refer
14091410 // to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1410 // in the Using IAM guide.
1411 // in the IAM User Guide.
14111412 func (c *IAM) DetachUserPolicy(input *DetachUserPolicyInput) (*DetachUserPolicyOutput, error) {
14121413 req, out := c.DetachUserPolicyRequest(input)
14131414 err := req.Send()
14651466
14661467 // Generates a credential report for the AWS account. For more information about
14671468 // the credential report, see Getting Credential Reports (http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html)
1468 // in the Using IAM guide.
1469 // in the IAM User Guide.
14691470 func (c *IAM) GenerateCredentialReport(input *GenerateCredentialReportInput) (*GenerateCredentialReportOutput, error) {
14701471 req, out := c.GenerateCredentialReportRequest(input)
14711472 err := req.Send()
16001601 //
16011602 // For information about limitations on IAM entities, see Limitations on IAM
16021603 // Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
1603 // in the Using IAM guide.
1604 // in the IAM User Guide.
16041605 func (c *IAM) GetAccountSummary(input *GetAccountSummaryInput) (*GetAccountSummaryOutput, error) {
16051606 req, out := c.GetAccountSummaryRequest(input)
1607 err := req.Send()
1608 return out, err
1609 }
1610
1611 const opGetContextKeysForCustomPolicy = "GetContextKeysForCustomPolicy"
1612
1613 // GetContextKeysForCustomPolicyRequest generates a request for the GetContextKeysForCustomPolicy operation.
1614 func (c *IAM) GetContextKeysForCustomPolicyRequest(input *GetContextKeysForCustomPolicyInput) (req *request.Request, output *GetContextKeysForPolicyResponse) {
1615 op := &request.Operation{
1616 Name: opGetContextKeysForCustomPolicy,
1617 HTTPMethod: "POST",
1618 HTTPPath: "/",
1619 }
1620
1621 if input == nil {
1622 input = &GetContextKeysForCustomPolicyInput{}
1623 }
1624
1625 req = c.newRequest(op, input, output)
1626 output = &GetContextKeysForPolicyResponse{}
1627 req.Data = output
1628 return
1629 }
1630
1631 // Gets a list of all of the context keys referenced in Condition elements in
1632 // the input policies. The policies are supplied as a list of one or more strings.
1633 // To get the context keys from policies associated with an IAM user, group,
1634 // or role, use GetContextKeysForPrincipalPolicy.
1635 //
1636 // Context keys are variables maintained by AWS and its services that provide
1637 // details about the context of an API query request, and can be evaluated by
1638 // using the Condition element of an IAM policy. Use GetContextKeysForCustomPolicy
1639 // to understand what key names and values you must supply when you call SimulateCustomPolicy.
1640 // Note that all parameters are shown in unencoded form here for clarity, but
1641 // must be URL encoded to be included as a part of a real HTML request.
1642 func (c *IAM) GetContextKeysForCustomPolicy(input *GetContextKeysForCustomPolicyInput) (*GetContextKeysForPolicyResponse, error) {
1643 req, out := c.GetContextKeysForCustomPolicyRequest(input)
1644 err := req.Send()
1645 return out, err
1646 }
1647
1648 const opGetContextKeysForPrincipalPolicy = "GetContextKeysForPrincipalPolicy"
1649
1650 // GetContextKeysForPrincipalPolicyRequest generates a request for the GetContextKeysForPrincipalPolicy operation.
1651 func (c *IAM) GetContextKeysForPrincipalPolicyRequest(input *GetContextKeysForPrincipalPolicyInput) (req *request.Request, output *GetContextKeysForPolicyResponse) {
1652 op := &request.Operation{
1653 Name: opGetContextKeysForPrincipalPolicy,
1654 HTTPMethod: "POST",
1655 HTTPPath: "/",
1656 }
1657
1658 if input == nil {
1659 input = &GetContextKeysForPrincipalPolicyInput{}
1660 }
1661
1662 req = c.newRequest(op, input, output)
1663 output = &GetContextKeysForPolicyResponse{}
1664 req.Data = output
1665 return
1666 }
1667
1668 // Gets a list of all of the context keys referenced in Condition elements in
1669 // all of the IAM policies attached to the specified IAM entity. The entity
1670 // can be an IAM user, group, or role. If you specify a user, then the request
1671 // also includes all of the policies attached to groups that the user is a member
1672 // of.
1673 //
1674 // You can optionally include a list of one or more additional policies, specified
1675 // as strings. If you want to include only a list of policies by string, use
1676 // GetContextKeysForCustomPolicy instead.
1677 //
1678 // Note: This API discloses information about the permissions granted to other
1679 // users. If you do not want users to see other user's permissions, then consider
1680 // allowing them to use GetContextKeysForCustomPolicy instead.
1681 //
1682 // Context keys are variables maintained by AWS and its services that provide
1683 // details about the context of an API query request, and can be evaluated by
1684 // using the Condition element of an IAM policy. Use GetContextKeysForPrincipalPolicy
1685 // to understand what key names and values you must supply when you call SimulatePrincipalPolicy.
1686 func (c *IAM) GetContextKeysForPrincipalPolicy(input *GetContextKeysForPrincipalPolicyInput) (*GetContextKeysForPolicyResponse, error) {
1687 req, out := c.GetContextKeysForPrincipalPolicyRequest(input)
16061688 err := req.Send()
16071689 return out, err
16081690 }
16291711
16301712 // Retrieves a credential report for the AWS account. For more information about
16311713 // the credential report, see Getting Credential Reports (http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html)
1632 // in the Using IAM guide.
1714 // in the IAM User Guide.
16331715 func (c *IAM) GetCredentialReport(input *GetCredentialReportInput) (*GetCredentialReportOutput, error) {
16341716 req, out := c.GetCredentialReportRequest(input)
16351717 err := req.Send()
17071789 //
17081790 // For more information about policies, refer to Managed Policies and Inline
17091791 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1710 // in the Using IAM guide.
1792 // in the IAM User Guide.
17111793 func (c *IAM) GetGroupPolicy(input *GetGroupPolicyInput) (*GetGroupPolicyOutput, error) {
17121794 req, out := c.GetGroupPolicyRequest(input)
17131795 err := req.Send()
18331915 //
18341916 // For more information about policies, refer to Managed Policies and Inline
18351917 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1836 // in the Using IAM guide.
1918 // in the IAM User Guide.
18371919 func (c *IAM) GetPolicy(input *GetPolicyInput) (*GetPolicyOutput, error) {
18381920 req, out := c.GetPolicyRequest(input)
18391921 err := req.Send()
18711953 //
18721954 // For more information about the types of policies, refer to Managed Policies
18731955 // and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1874 // in the Using IAM guide.
1956 // in the IAM User Guide.
18751957 func (c *IAM) GetPolicyVersion(input *GetPolicyVersionInput) (*GetPolicyVersionOutput, error) {
18761958 req, out := c.GetPolicyVersionRequest(input)
18771959 err := req.Send()
19382020 //
19392021 // For more information about policies, refer to Managed Policies and Inline
19402022 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
1941 // in the Using IAM guide.
2023 // in the IAM User Guide.
19422024 //
19432025 // For more information about roles, go to Using Roles to Delegate Permissions
19442026 // and Federate Identities (http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html).
20992181 //
21002182 // For more information about policies, refer to Managed Policies and Inline
21012183 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2102 // in the Using IAM guide.
2184 // in the IAM User Guide.
21032185 func (c *IAM) GetUserPolicy(input *GetUserPolicyInput) (*GetUserPolicyOutput, error) {
21042186 req, out := c.GetUserPolicyRequest(input)
21052187 err := req.Send()
21862268
21872269 // Lists the account aliases associated with the account. For information about
21882270 // using an AWS account alias, see Using an Alias for Your AWS Account ID (http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html)
2189 // in the Using IAM guide.
2271 // in the IAM User Guide.
21902272 //
21912273 // You can paginate the results using the MaxItems and Marker parameters.
21922274 func (c *IAM) ListAccountAliases(input *ListAccountAliasesInput) (*ListAccountAliasesOutput, error) {
22332315 // A group can also have inline policies embedded with it. To list the inline
22342316 // policies for a group, use the ListGroupPolicies API. For information about
22352317 // policies, refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2236 // in the Using IAM guide.
2318 // in the IAM User Guide.
22372319 //
22382320 // You can paginate the results using the MaxItems and Marker parameters. You
22392321 // can use the PathPrefix parameter to limit the list of policies to only those
22842366 // A role can also have inline policies embedded with it. To list the inline
22852367 // policies for a role, use the ListRolePolicies API. For information about
22862368 // policies, refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2287 // in the Using IAM guide.
2369 // in the IAM User Guide.
22882370 //
22892371 // You can paginate the results using the MaxItems and Marker parameters. You
22902372 // can use the PathPrefix parameter to limit the list of policies to only those
23352417 // A user can also have inline policies embedded with it. To list the inline
23362418 // policies for a user, use the ListUserPolicies API. For information about
23372419 // policies, refer to Managed Policies and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2338 // in the Using IAM guide.
2420 // in the IAM User Guide.
23392421 //
23402422 // You can paginate the results using the MaxItems and Marker parameters. You
23412423 // can use the PathPrefix parameter to limit the list of policies to only those
24362518 // policies that are attached to a group, use ListAttachedGroupPolicies. For
24372519 // more information about policies, refer to Managed Policies and Inline Policies
24382520 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2439 // in the Using IAM guide.
2521 // in the IAM User Guide.
24402522 //
24412523 // You can paginate the results using the MaxItems and Marker parameters. If
24422524 // there are no inline policies embedded with the specified group, the action
27362818 //
27372819 // For more information about managed policies, refer to Managed Policies and
27382820 // Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2739 // in the Using IAM guide.
2821 // in the IAM User Guide.
27402822 func (c *IAM) ListPolicies(input *ListPoliciesInput) (*ListPoliciesOutput, error) {
27412823 req, out := c.ListPoliciesRequest(input)
27422824 err := req.Send()
27752857 //
27762858 // For more information about managed policies, refer to Managed Policies and
27772859 // Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2778 // in the Using IAM guide.
2860 // in the IAM User Guide.
27792861 func (c *IAM) ListPolicyVersions(input *ListPolicyVersionsInput) (*ListPolicyVersionsOutput, error) {
27802862 req, out := c.ListPolicyVersionsRequest(input)
27812863 err := req.Send()
28152897 // policies that are attached to a role, use ListAttachedRolePolicies. For more
28162898 // information about policies, refer to Managed Policies and Inline Policies
28172899 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
2818 // in the Using IAM guide.
2900 // in the IAM User Guide.
28192901 //
28202902 // You can paginate the results using the MaxItems and Marker parameters. If
28212903 // there are no inline policies embedded with the specified role, the action
30673149 // policies that are attached to a user, use ListAttachedUserPolicies. For more
30683150 // information about policies, refer to Managed Policies and Inline Policies
30693151 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
3070 // in the Using IAM guide.
3152 // in the IAM User Guide.
30713153 //
30723154 // You can paginate the results using the MaxItems and Marker parameters. If
30733155 // there are no inline policies embedded with the specified user, the action
32013283 // policy to a group, use AttachGroupPolicy. To create a new managed policy,
32023284 // use CreatePolicy. For information about policies, refer to Managed Policies
32033285 // and Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
3204 // in the Using IAM guide.
3286 // in the IAM User Guide.
32053287 //
32063288 // For information about limits on the number of inline policies that you can
32073289 // embed in a group, see Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
3208 // in the Using IAM guide.
3290 // in the IAM User Guide.
32093291 //
32103292 // Because policy documents can be large, you should use POST rather than GET
32113293 // when calling PutGroupPolicy. For general information about using the Query
32503332 // policy to a role, use AttachRolePolicy. To create a new managed policy, use
32513333 // CreatePolicy. For information about policies, refer to Managed Policies and
32523334 // Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
3253 // in the Using IAM guide.
3335 // in the IAM User Guide.
32543336 //
32553337 // For information about limits on the number of inline policies that you can
32563338 // embed with a role, see Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
3257 // in the Using IAM guide.
3339 // in the IAM User Guide.
32583340 //
32593341 // Because policy documents can be large, you should use POST rather than GET
32603342 // when calling PutRolePolicy. For general information about using the Query
32933375 // policy to a user, use AttachUserPolicy. To create a new managed policy, use
32943376 // CreatePolicy. For information about policies, refer to Managed Policies and
32953377 // Inline Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
3296 // in the Using IAM guide.
3378 // in the IAM User Guide.
32973379 //
32983380 // For information about limits on the number of inline policies that you can
32993381 // embed in a user, see Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
3300 // in the Using IAM guide.
3382 // in the IAM User Guide.
33013383 //
33023384 // Because policy documents can be large, you should use POST rather than GET
33033385 // when calling PutUserPolicy. For general information about using the Query
34623544 //
34633545 // For information about managed policies, refer to Managed Policies and Inline
34643546 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html)
3465 // in the Using IAM guide.
3547 // in the IAM User Guide.
34663548 func (c *IAM) SetDefaultPolicyVersion(input *SetDefaultPolicyVersionInput) (*SetDefaultPolicyVersionOutput, error) {
34673549 req, out := c.SetDefaultPolicyVersionRequest(input)
3550 err := req.Send()
3551 return out, err
3552 }
3553
3554 const opSimulateCustomPolicy = "SimulateCustomPolicy"
3555
3556 // SimulateCustomPolicyRequest generates a request for the SimulateCustomPolicy operation.
3557 func (c *IAM) SimulateCustomPolicyRequest(input *SimulateCustomPolicyInput) (req *request.Request, output *SimulatePolicyResponse) {
3558 op := &request.Operation{
3559 Name: opSimulateCustomPolicy,
3560 HTTPMethod: "POST",
3561 HTTPPath: "/",
3562 }
3563
3564 if input == nil {
3565 input = &SimulateCustomPolicyInput{}
3566 }
3567
3568 req = c.newRequest(op, input, output)
3569 output = &SimulatePolicyResponse{}
3570 req.Data = output
3571 return
3572 }
3573
3574 // Simulate a set of IAM policies against a list of API actions and AWS resources
3575 // to determine the policies' effective permissions. The policies are provided
3576 // as a list of strings.
3577 //
3578 // The simulation does not perform the API actions, it only checks the authorization
3579 // to determine if the simulated policies allow or deny the actions.
3580 //
3581 // If you want to simulate existing policies attached to an IAM user, group,
3582 // or role, use SimulatePrincipalPolicy instead.
3583 //
3584 // Context keys are variables maintained by AWS and its services that provide
3585 // details about the context of an API query request, and can be evaluated by
3586 // using the Condition element of an IAM policy. To get the list of context
3587 // keys required by the policies to simulate them correctly, use GetContextKeysForCustomPolicy.
3588 //
3589 // If the output is long, you can paginate the results using the MaxItems and
3590 // Marker parameters.
3591 func (c *IAM) SimulateCustomPolicy(input *SimulateCustomPolicyInput) (*SimulatePolicyResponse, error) {
3592 req, out := c.SimulateCustomPolicyRequest(input)
3593 err := req.Send()
3594 return out, err
3595 }
3596
3597 const opSimulatePrincipalPolicy = "SimulatePrincipalPolicy"
3598
3599 // SimulatePrincipalPolicyRequest generates a request for the SimulatePrincipalPolicy operation.
3600 func (c *IAM) SimulatePrincipalPolicyRequest(input *SimulatePrincipalPolicyInput) (req *request.Request, output *SimulatePolicyResponse) {
3601 op := &request.Operation{
3602 Name: opSimulatePrincipalPolicy,
3603 HTTPMethod: "POST",
3604 HTTPPath: "/",
3605 }
3606
3607 if input == nil {
3608 input = &SimulatePrincipalPolicyInput{}
3609 }
3610
3611 req = c.newRequest(op, input, output)
3612 output = &SimulatePolicyResponse{}
3613 req.Data = output
3614 return
3615 }
3616
3617 // Simulate the set of IAM policies attached to an IAM entity against a list
3618 // of API actions and AWS resources to determine the policies' effective permissions.
3619 // The entity can be an IAM user, group, or role. If you specify a user, then
3620 // the simulation also includes all of the policies attached to groups that
3621 // the user is a member of.
3622 //
3623 // You can optionally include a list of one or more additional policies specified
3624 // as strings to include in the simulation. If you want to simulate only policies
3625 // specified as strings, use SimulateCustomPolicy instead.
3626 //
3627 // The simulation does not perform the API actions, it only checks the authorization
3628 // to determine if the simulated policies allow or deny the actions.
3629 //
3630 // Note: This API discloses information about the permissions granted to other
3631 // users. If you do not want users to see other user's permissions, then consider
3632 // allowing them to use SimulateCustomPolicy instead.
3633 //
3634 // Context keys are variables maintained by AWS and its services that provide
3635 // details about the context of an API query request, and can be evaluated by
3636 // using the Condition element of an IAM policy. To get the list of context
3637 // keys required by the policies to simulate them correctly, use GetContextKeysForPrincipalPolicy.
3638 //
3639 // If the output is long, you can paginate the results using the MaxItems and
3640 // Marker parameters.
3641 func (c *IAM) SimulatePrincipalPolicy(input *SimulatePrincipalPolicyInput) (*SimulatePolicyResponse, error) {
3642 req, out := c.SimulatePrincipalPolicyRequest(input)
34683643 err := req.Send()
34693644 return out, err
34703645 }
35003675 //
35013676 // For information about rotating keys, see Managing Keys and Certificates
35023677 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html)
3503 // in the Using IAM guide.
3678 // in the IAM User Guide.
35043679 func (c *IAM) UpdateAccessKey(input *UpdateAccessKeyInput) (*UpdateAccessKeyOutput, error) {
35053680 req, out := c.UpdateAccessKeyRequest(input)
35063681 err := req.Send()
35363711 //
35373712 // For more information about using a password policy, see Managing an IAM
35383713 // Password Policy (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html)
3539 // in the Using IAM guide.
3714 // in the IAM User Guide.
35403715 func (c *IAM) UpdateAccountPasswordPolicy(input *UpdateAccountPasswordPolicyInput) (*UpdateAccountPasswordPolicyOutput, error) {
35413716 req, out := c.UpdateAccountPasswordPolicyRequest(input)
35423717 err := req.Send()
35963771 //
35973772 // You should understand the implications of changing a group's path or name.
35983773 // For more information, see Renaming Users and Groups (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html)
3599 // in the Using IAM guide. To change a group name the requester must have appropriate
3774 // in the IAM User Guide. To change a group name the requester must have appropriate
36003775 // permissions on both the source object and the target object. For example,
36013776 // to change Managers to MGRs, the entity making the request must have permission
36023777 // on Managers and MGRs, or must have permission on all (*). For more information
36323807 //
36333808 // Users can change their own passwords by calling ChangePassword. For more
36343809 // information about modifying passwords, see Managing Passwords (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html)
3635 // in the Using IAM guide.
3810 // in the IAM User Guide.
36363811 func (c *IAM) UpdateLoginProfile(input *UpdateLoginProfileInput) (*UpdateLoginProfileOutput, error) {
36373812 req, out := c.UpdateLoginProfileRequest(input)
36383813 err := req.Send()
37683943 //
37693944 // You should understand the implications of changing a server certificate's
37703945 // path or name. For more information, see Managing Server Certificates (http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html)
3771 // in the Using IAM guide. To change a server certificate name the requester
3946 // in the IAM User Guide. To change a server certificate name the requester
37723947 // must have appropriate permissions on both the source object and the target
37733948 // object. For example, to change the name from ProductionCert to ProdCert,
37743949 // the entity making the request must have permission on ProductionCert and
38394014 //
38404015 // You should understand the implications of changing a user's path or name.
38414016 // For more information, see Renaming Users and Groups (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html)
3842 // in the Using IAM guide. To change a user name the requester must have appropriate
4017 // in the IAM User Guide. To change a user name the requester must have appropriate
38434018 // permissions on both the source object and the target object. For example,
38444019 // to change Bob to Robert, the entity making the request must have permission
38454020 // on Bob and Robert, or must have permission on all (*). For more information
39104085 //
39114086 // For information about the number of server certificates you can upload,
39124087 // see Limitations on IAM Entities (http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html)
3913 // in the Using IAM guide.
4088 // in the IAM User Guide.
39144089 //
39154090 // Because the body of the public key certificate, private key, and the certificate
39164091 // chain can be large, you should use POST rather than GET when calling UploadServerCertificate.
39184093 // API, go to Signing AWS API Requests (http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html)
39194094 // in the AWS General Reference. For general information about using the Query
39204095 // API with IAM, go to Making Query Requests (http://docs.aws.amazon.com/IAM/latest/UserGuide/IAM_UsingQueryAPI.html)
3921 // in the Using IAM guide.
4096 // in the IAM User Guide.
39224097 func (c *IAM) UploadServerCertificate(input *UploadServerCertificateInput) (*UploadServerCertificateOutput, error) {
39234098 req, out := c.UploadServerCertificateRequest(input)
39244099 err := req.Send()
39794154 // key, you must create a new access key.
39804155 type AccessKey struct {
39814156 // The ID for this access key.
3982 AccessKeyId *string `type:"string" required:"true"`
4157 AccessKeyId *string `min:"16" type:"string" required:"true"`
39834158
39844159 // The date when the access key was created.
39854160 CreateDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
39924167 Status *string `type:"string" required:"true" enum:"statusType"`
39934168
39944169 // The name of the IAM user that the access key is associated with.
3995 UserName *string `type:"string" required:"true"`
4170 UserName *string `min:"1" type:"string" required:"true"`
39964171
39974172 metadataAccessKey `json:"-" xml:"-"`
39984173 }
40744249 // This data type is used as a response element in the ListAccessKeys action.
40754250 type AccessKeyMetadata struct {
40764251 // The ID for this access key.
4077 AccessKeyId *string `type:"string"`
4252 AccessKeyId *string `min:"16" type:"string"`
40784253
40794254 // The date when the access key was created.
40804255 CreateDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
40844259 Status *string `type:"string" enum:"statusType"`
40854260
40864261 // The name of the IAM user that the key is associated with.
4087 UserName *string `type:"string"`
4262 UserName *string `min:"1" type:"string"`
40884263
40894264 metadataAccessKeyMetadata `json:"-" xml:"-"`
40904265 }
41054280
41064281 type AddClientIDToOpenIDConnectProviderInput struct {
41074282 // The client ID (also known as audience) to add to the IAM OpenID Connect provider.
4108 ClientID *string `type:"string" required:"true"`
4283 ClientID *string `min:"1" type:"string" required:"true"`
41094284
41104285 // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider
41114286 // to add the client ID to. You can get a list of OIDC provider ARNs by using
41124287 // the ListOpenIDConnectProviders action.
4113 OpenIDConnectProviderArn *string `type:"string" required:"true"`
4288 OpenIDConnectProviderArn *string `min:"20" type:"string" required:"true"`
41144289
41154290 metadataAddClientIDToOpenIDConnectProviderInput `json:"-" xml:"-"`
41164291 }
41494324
41504325 type AddRoleToInstanceProfileInput struct {
41514326 // The name of the instance profile to update.
4152 InstanceProfileName *string `type:"string" required:"true"`
4327 InstanceProfileName *string `min:"1" type:"string" required:"true"`
41534328
41544329 // The name of the role to add.
4155 RoleName *string `type:"string" required:"true"`
4330 RoleName *string `min:"1" type:"string" required:"true"`
41564331
41574332 metadataAddRoleToInstanceProfileInput `json:"-" xml:"-"`
41584333 }
41914366
41924367 type AddUserToGroupInput struct {
41934368 // The name of the group to update.
4194 GroupName *string `type:"string" required:"true"`
4369 GroupName *string `min:"1" type:"string" required:"true"`
41954370
41964371 // The name of the user to add.
4197 UserName *string `type:"string" required:"true"`
4372 UserName *string `min:"1" type:"string" required:"true"`
41984373
41994374 metadataAddUserToGroupInput `json:"-" xml:"-"`
42004375 }
42334408
42344409 type AttachGroupPolicyInput struct {
42354410 // The name (friendly name, not ARN) of the group to attach the policy to.
4236 GroupName *string `type:"string" required:"true"`
4411 GroupName *string `min:"1" type:"string" required:"true"`
42374412
42384413 // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
42394414 //
42404415 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
42414416 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
42424417 // in the AWS General Reference.
4243 PolicyArn *string `type:"string" required:"true"`
4418 PolicyArn *string `min:"20" type:"string" required:"true"`
42444419
42454420 metadataAttachGroupPolicyInput `json:"-" xml:"-"`
42464421 }
42834458 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
42844459 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
42854460 // in the AWS General Reference.
4286 PolicyArn *string `type:"string" required:"true"`
4461 PolicyArn *string `min:"20" type:"string" required:"true"`
42874462
42884463 // The name (friendly name, not ARN) of the role to attach the policy to.
4289 RoleName *string `type:"string" required:"true"`
4464 RoleName *string `min:"1" type:"string" required:"true"`
42904465
42914466 metadataAttachRolePolicyInput `json:"-" xml:"-"`
42924467 }
43294504 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
43304505 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
43314506 // in the AWS General Reference.
4332 PolicyArn *string `type:"string" required:"true"`
4507 PolicyArn *string `min:"20" type:"string" required:"true"`
43334508
43344509 // The name (friendly name, not ARN) of the user to attach the policy to.
4335 UserName *string `type:"string" required:"true"`
4510 UserName *string `min:"1" type:"string" required:"true"`
43364511
43374512 metadataAttachUserPolicyInput `json:"-" xml:"-"`
43384513 }
43854560 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
43864561 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
43874562 // in the AWS General Reference.
4388 PolicyArn *string `type:"string"`
4563 PolicyArn *string `min:"20" type:"string"`
43894564
43904565 // The friendly name of the attached policy.
4391 PolicyName *string `type:"string"`
4566 PolicyName *string `min:"1" type:"string"`
43924567
43934568 metadataAttachedPolicy `json:"-" xml:"-"`
43944569 }
44104585 type ChangePasswordInput struct {
44114586 // The new password. The new password must conform to the AWS account's password
44124587 // policy, if one exists.
4413 NewPassword *string `type:"string" required:"true"`
4588 NewPassword *string `min:"1" type:"string" required:"true"`
44144589
44154590 // The IAM user's current password.
4416 OldPassword *string `type:"string" required:"true"`
4591 OldPassword *string `min:"1" type:"string" required:"true"`
44174592
44184593 metadataChangePasswordInput `json:"-" xml:"-"`
44194594 }
44504625 return s.String()
44514626 }
44524627
4628 // Contains information about a condition context key. It includes the name
4629 // of the key and specifies the value (or values, if the context key supports
4630 // multiple values) to use in the simulation. This information is used when
4631 // evaluating the Condition elements of the input policies.
4632 //
4633 // This data type is used as an input parameter to SimulatePolicy.
4634 type ContextEntry struct {
4635 // The full name of a condition context key, including the service prefix. For
4636 // example, aws:SourceIp or s3:VersionId.
4637 ContextKeyName *string `min:"5" type:"string"`
4638
4639 // The data type of the value (or values) specified in the ContextKeyValues
4640 // parameter.
4641 ContextKeyType *string `type:"string" enum:"ContextKeyTypeEnum"`
4642
4643 // The value (or values, if the condition context key supports multiple values)
4644 // to provide to the simulation for use when the key is referenced by a Condition
4645 // element in an input policy.
4646 ContextKeyValues []*string `type:"list"`
4647
4648 metadataContextEntry `json:"-" xml:"-"`
4649 }
4650
4651 type metadataContextEntry struct {
4652 SDKShapeTraits bool `type:"structure"`
4653 }
4654
4655 // String returns the string representation
4656 func (s ContextEntry) String() string {
4657 return awsutil.Prettify(s)
4658 }
4659
4660 // GoString returns the string representation
4661 func (s ContextEntry) GoString() string {
4662 return s.String()
4663 }
4664
44534665 type CreateAccessKeyInput struct {
44544666 // The user name that the new key will belong to.
4455 UserName *string `type:"string"`
4667 UserName *string `min:"1" type:"string"`
44564668
44574669 metadataCreateAccessKeyInput `json:"-" xml:"-"`
44584670 }
44954707
44964708 type CreateAccountAliasInput struct {
44974709 // The account alias to create.
4498 AccountAlias *string `type:"string" required:"true"`
4710 AccountAlias *string `min:"3" type:"string" required:"true"`
44994711
45004712 metadataCreateAccountAliasInput `json:"-" xml:"-"`
45014713 }
45344746
45354747 type CreateGroupInput struct {
45364748 // The name of the group to create. Do not include the path in this value.
4537 GroupName *string `type:"string" required:"true"`
4749 GroupName *string `min:"1" type:"string" required:"true"`
45384750
45394751 // The path to the group. For more information about paths, see IAM Identifiers
45404752 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
45424754 //
45434755 // This parameter is optional. If it is not included, it defaults to a slash
45444756 // (/).
4545 Path *string `type:"string"`
4757 Path *string `min:"1" type:"string"`
45464758
45474759 metadataCreateGroupInput `json:"-" xml:"-"`
45484760 }
45854797
45864798 type CreateInstanceProfileInput struct {
45874799 // The name of the instance profile to create.
4588 InstanceProfileName *string `type:"string" required:"true"`
4800 InstanceProfileName *string `min:"1" type:"string" required:"true"`
45894801
45904802 // The path to the instance profile. For more information about paths, see IAM
45914803 // Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
45934805 //
45944806 // This parameter is optional. If it is not included, it defaults to a slash
45954807 // (/).
4596 Path *string `type:"string"`
4808 Path *string `min:"1" type:"string"`
45974809
45984810 metadataCreateInstanceProfileInput `json:"-" xml:"-"`
45994811 }
46364848
46374849 type CreateLoginProfileInput struct {
46384850 // The new password for the user.
4639 Password *string `type:"string" required:"true"`
4851 Password *string `min:"1" type:"string" required:"true"`
46404852
46414853 // Specifies whether the user is required to set a new password on next sign-in.
46424854 PasswordResetRequired *bool `type:"boolean"`
46434855
46444856 // The name of the user to create a password for.
4645 UserName *string `type:"string" required:"true"`
4857 UserName *string `min:"1" type:"string" required:"true"`
46464858
46474859 metadataCreateLoginProfileInput `json:"-" xml:"-"`
46484860 }
47154927 //
47164928 // For more information about obtaining the OIDC provider's thumbprint, see
47174929 // Obtaining the Thumbprint for an OpenID Connect Provider (http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html)
4718 // in the Using IAM guide.
4930 // in the IAM User Guide.
47194931 ThumbprintList []*string `type:"list" required:"true"`
47204932
47214933 // The URL of the identity provider. The URL must begin with "https://" and
47274939 // You cannot register the same provider multiple times in a single AWS account.
47284940 // If you try to submit a URL that has already been used for an OpenID Connect
47294941 // provider in the AWS account, you will get an error.
4730 Url *string `type:"string" required:"true"`
4942 Url *string `min:"1" type:"string" required:"true"`
47314943
47324944 metadataCreateOpenIDConnectProviderInput `json:"-" xml:"-"`
47334945 }
47504962 type CreateOpenIDConnectProviderOutput struct {
47514963 // The Amazon Resource Name (ARN) of the IAM OpenID Connect provider that was
47524964 // created. For more information, see OpenIDConnectProviderListEntry.
4753 OpenIDConnectProviderArn *string `type:"string"`
4965 OpenIDConnectProviderArn *string `min:"20" type:"string"`
47544966
47554967 metadataCreateOpenIDConnectProviderOutput `json:"-" xml:"-"`
47564968 }
47824994 // The path for the policy.
47834995 //
47844996 // For more information about paths, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
4785 // in the Using IAM guide.
4997 // in the IAM User Guide.
47864998 //
47874999 // This parameter is optional. If it is not included, it defaults to a slash
47885000 // (/).
47895001 Path *string `type:"string"`
47905002
47915003 // The policy document.
4792 PolicyDocument *string `type:"string" required:"true"`
5004 PolicyDocument *string `min:"1" type:"string" required:"true"`
47935005
47945006 // The name of the policy document.
4795 PolicyName *string `type:"string" required:"true"`
5007 PolicyName *string `min:"1" type:"string" required:"true"`
47965008
47975009 metadataCreatePolicyInput `json:"-" xml:"-"`
47985010 }
48395051 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
48405052 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
48415053 // in the AWS General Reference.
4842 PolicyArn *string `type:"string" required:"true"`
5054 PolicyArn *string `min:"20" type:"string" required:"true"`
48435055
48445056 // The policy document.
4845 PolicyDocument *string `type:"string" required:"true"`
5057 PolicyDocument *string `min:"1" type:"string" required:"true"`
48465058
48475059 // Specifies whether to set this version as the policy's default version.
48485060 //
48525064 //
48535065 // For more information about managed policy versions, see Versioning for Managed
48545066 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
4855 // in the Using IAM guide.
5067 // in the IAM User Guide.
48565068 SetAsDefault *bool `type:"boolean"`
48575069
48585070 metadataCreatePolicyVersionInput `json:"-" xml:"-"`
48965108
48975109 type CreateRoleInput struct {
48985110 // The policy that grants an entity permission to assume the role.
4899 AssumeRolePolicyDocument *string `type:"string" required:"true"`
5111 AssumeRolePolicyDocument *string `min:"1" type:"string" required:"true"`
49005112
49015113 // The path to the role. For more information about paths, see IAM Identifiers
49025114 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
49045116 //
49055117 // This parameter is optional. If it is not included, it defaults to a slash
49065118 // (/).
4907 Path *string `type:"string"`
5119 Path *string `min:"1" type:"string"`
49085120
49095121 // The name of the role to create.
4910 RoleName *string `type:"string" required:"true"`
5122 RoleName *string `min:"1" type:"string" required:"true"`
49115123
49125124 metadataCreateRoleInput `json:"-" xml:"-"`
49135125 }
49505162
49515163 type CreateSAMLProviderInput struct {
49525164 // The name of the provider to create.
4953 Name *string `type:"string" required:"true"`
5165 Name *string `min:"1" type:"string" required:"true"`
49545166
49555167 // An XML document generated by an identity provider (IdP) that supports SAML
49565168 // 2.0. The document includes the issuer's name, expiration information, and
49585170 // that are received from the IdP. You must generate the metadata document using
49595171 // the identity management software that is used as your organization's IdP.
49605172 //
4961 // For more information, see Creating Temporary Security Credentials for SAML
4962 // Federation (http://docs.aws.amazon.com/STS/latest/UsingSTS/CreatingSAML.html)
4963 // in the Using Temporary Security Credentials guide.
4964 SAMLMetadataDocument *string `type:"string" required:"true"`
5173 // For more information, see About SAML 2.0-based Federation (http://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_saml.html)
5174 // in the IAM User Guide
5175 SAMLMetadataDocument *string `min:"1000" type:"string" required:"true"`
49655176
49665177 metadataCreateSAMLProviderInput `json:"-" xml:"-"`
49675178 }
49835194 // Contains the response to a successful CreateSAMLProvider request.
49845195 type CreateSAMLProviderOutput struct {
49855196 // The Amazon Resource Name (ARN) of the SAML provider.
4986 SAMLProviderArn *string `type:"string"`
5197 SAMLProviderArn *string `min:"20" type:"string"`
49875198
49885199 metadataCreateSAMLProviderOutput `json:"-" xml:"-"`
49895200 }
50095220 //
50105221 // This parameter is optional. If it is not included, it defaults to a slash
50115222 // (/).
5012 Path *string `type:"string"`
5223 Path *string `min:"1" type:"string"`
50135224
50145225 // The name of the user to create.
5015 UserName *string `type:"string" required:"true"`
5226 UserName *string `min:"1" type:"string" required:"true"`
50165227
50175228 metadataCreateUserInput `json:"-" xml:"-"`
50185229 }
50605271 //
50615272 // This parameter is optional. If it is not included, it defaults to a slash
50625273 // (/).
5063 Path *string `type:"string"`
5274 Path *string `min:"1" type:"string"`
50645275
50655276 // The name of the virtual MFA device. Use with path to uniquely identify a
50665277 // virtual MFA device.
5067 VirtualMFADeviceName *string `type:"string" required:"true"`
5278 VirtualMFADeviceName *string `min:"1" type:"string" required:"true"`
50685279
50695280 metadataCreateVirtualMFADeviceInput `json:"-" xml:"-"`
50705281 }
51085319 type DeactivateMFADeviceInput struct {
51095320 // The serial number that uniquely identifies the MFA device. For virtual MFA
51105321 // devices, the serial number is the device ARN.
5111 SerialNumber *string `type:"string" required:"true"`
5322 SerialNumber *string `min:"9" type:"string" required:"true"`
51125323
51135324 // The name of the user whose MFA device you want to deactivate.
5114 UserName *string `type:"string" required:"true"`
5325 UserName *string `min:"1" type:"string" required:"true"`
51155326
51165327 metadataDeactivateMFADeviceInput `json:"-" xml:"-"`
51175328 }
51515362 type DeleteAccessKeyInput struct {
51525363 // The access key ID for the access key ID and secret access key you want to
51535364 // delete.
5154 AccessKeyId *string `type:"string" required:"true"`
5365 AccessKeyId *string `min:"16" type:"string" required:"true"`
51555366
51565367 // The name of the user whose key you want to delete.
5157 UserName *string `type:"string"`
5368 UserName *string `min:"1" type:"string"`
51585369
51595370 metadataDeleteAccessKeyInput `json:"-" xml:"-"`
51605371 }
51935404
51945405 type DeleteAccountAliasInput struct {
51955406 // The name of the account alias to delete.
5196 AccountAlias *string `type:"string" required:"true"`
5407 AccountAlias *string `min:"3" type:"string" required:"true"`
51975408
51985409 metadataDeleteAccountAliasInput `json:"-" xml:"-"`
51995410 }
52685479
52695480 type DeleteGroupInput struct {
52705481 // The name of the group to delete.
5271 GroupName *string `type:"string" required:"true"`
5482 GroupName *string `min:"1" type:"string" required:"true"`
52725483
52735484 metadataDeleteGroupInput `json:"-" xml:"-"`
52745485 }
53085519 type DeleteGroupPolicyInput struct {
53095520 // The name (friendly name, not ARN) identifying the group that the policy is
53105521 // embedded in.
5311 GroupName *string `type:"string" required:"true"`
5522 GroupName *string `min:"1" type:"string" required:"true"`
53125523
53135524 // The name identifying the policy document to delete.
5314 PolicyName *string `type:"string" required:"true"`
5525 PolicyName *string `min:"1" type:"string" required:"true"`
53155526
53165527 metadataDeleteGroupPolicyInput `json:"-" xml:"-"`
53175528 }
53505561
53515562 type DeleteInstanceProfileInput struct {
53525563 // The name of the instance profile to delete.
5353 InstanceProfileName *string `type:"string" required:"true"`
5564 InstanceProfileName *string `min:"1" type:"string" required:"true"`
53545565
53555566 metadataDeleteInstanceProfileInput `json:"-" xml:"-"`
53565567 }
53895600
53905601 type DeleteLoginProfileInput struct {
53915602 // The name of the user whose password you want to delete.
5392 UserName *string `type:"string" required:"true"`
5603 UserName *string `min:"1" type:"string" required:"true"`
53935604
53945605 metadataDeleteLoginProfileInput `json:"-" xml:"-"`
53955606 }
54305641 // The Amazon Resource Name (ARN) of the IAM OpenID Connect provider to delete.
54315642 // You can get a list of OpenID Connect provider ARNs by using the ListOpenIDConnectProviders
54325643 // action.
5433 OpenIDConnectProviderArn *string `type:"string" required:"true"`
5644 OpenIDConnectProviderArn *string `min:"20" type:"string" required:"true"`
54345645
54355646 metadataDeleteOpenIDConnectProviderInput `json:"-" xml:"-"`
54365647 }
54735684 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
54745685 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
54755686 // in the AWS General Reference.
5476 PolicyArn *string `type:"string" required:"true"`
5687 PolicyArn *string `min:"20" type:"string" required:"true"`
54775688
54785689 metadataDeletePolicyInput `json:"-" xml:"-"`
54795690 }
55165727 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
55175728 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
55185729 // in the AWS General Reference.
5519 PolicyArn *string `type:"string" required:"true"`
5730 PolicyArn *string `min:"20" type:"string" required:"true"`
55205731
55215732 // The policy version to delete.
55225733 //
55235734 // For more information about managed policy versions, see Versioning for Managed
55245735 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
5525 // in the Using IAM guide.
5736 // in the IAM User Guide.
55265737 VersionId *string `type:"string" required:"true"`
55275738
55285739 metadataDeletePolicyVersionInput `json:"-" xml:"-"`
55625773
55635774 type DeleteRoleInput struct {
55645775 // The name of the role to delete.
5565 RoleName *string `type:"string" required:"true"`
5776 RoleName *string `min:"1" type:"string" required:"true"`
55665777
55675778 metadataDeleteRoleInput `json:"-" xml:"-"`
55685779 }
56015812
56025813 type DeleteRolePolicyInput struct {
56035814 // The name identifying the policy document to delete.
5604 PolicyName *string `type:"string" required:"true"`
5815 PolicyName *string `min:"1" type:"string" required:"true"`
56055816
56065817 // The name (friendly name, not ARN) identifying the role that the policy is
56075818 // embedded in.
5608 RoleName *string `type:"string" required:"true"`
5819 RoleName *string `min:"1" type:"string" required:"true"`
56095820
56105821 metadataDeleteRolePolicyInput `json:"-" xml:"-"`
56115822 }
56445855
56455856 type DeleteSAMLProviderInput struct {
56465857 // The Amazon Resource Name (ARN) of the SAML provider to delete.
5647 SAMLProviderArn *string `type:"string" required:"true"`
5858 SAMLProviderArn *string `min:"20" type:"string" required:"true"`
56485859
56495860 metadataDeleteSAMLProviderInput `json:"-" xml:"-"`
56505861 }
56835894
56845895 type DeleteSSHPublicKeyInput struct {
56855896 // The unique identifier for the SSH public key.
5686 SSHPublicKeyId *string `type:"string" required:"true"`
5897 SSHPublicKeyId *string `min:"20" type:"string" required:"true"`
56875898
56885899 // The name of the IAM user associated with the SSH public key.
5689 UserName *string `type:"string" required:"true"`
5900 UserName *string `min:"1" type:"string" required:"true"`
56905901
56915902 metadataDeleteSSHPublicKeyInput `json:"-" xml:"-"`
56925903 }
57255936
57265937 type DeleteServerCertificateInput struct {
57275938 // The name of the server certificate you want to delete.
5728 ServerCertificateName *string `type:"string" required:"true"`
5939 ServerCertificateName *string `min:"1" type:"string" required:"true"`
57295940
57305941 metadataDeleteServerCertificateInput `json:"-" xml:"-"`
57315942 }
57645975
57655976 type DeleteSigningCertificateInput struct {
57665977 // The ID of the signing certificate to delete.
5767 CertificateId *string `type:"string" required:"true"`
5978 CertificateId *string `min:"24" type:"string" required:"true"`
57685979
57695980 // The name of the user the signing certificate belongs to.
5770 UserName *string `type:"string"`
5981 UserName *string `min:"1" type:"string"`
57715982
57725983 metadataDeleteSigningCertificateInput `json:"-" xml:"-"`
57735984 }
58066017
58076018 type DeleteUserInput struct {
58086019 // The name of the user to delete.
5809 UserName *string `type:"string" required:"true"`
6020 UserName *string `min:"1" type:"string" required:"true"`
58106021
58116022 metadataDeleteUserInput `json:"-" xml:"-"`
58126023 }
58456056
58466057 type DeleteUserPolicyInput struct {
58476058 // The name identifying the policy document to delete.
5848 PolicyName *string `type:"string" required:"true"`
6059 PolicyName *string `min:"1" type:"string" required:"true"`
58496060
58506061 // The name (friendly name, not ARN) identifying the user that the policy is
58516062 // embedded in.
5852 UserName *string `type:"string" required:"true"`
6063 UserName *string `min:"1" type:"string" required:"true"`
58536064
58546065 metadataDeleteUserPolicyInput `json:"-" xml:"-"`
58556066 }
58896100 type DeleteVirtualMFADeviceInput struct {
58906101 // The serial number that uniquely identifies the MFA device. For virtual MFA
58916102 // devices, the serial number is the same as the ARN.
5892 SerialNumber *string `type:"string" required:"true"`
6103 SerialNumber *string `min:"9" type:"string" required:"true"`
58936104
58946105 metadataDeleteVirtualMFADeviceInput `json:"-" xml:"-"`
58956106 }
59286139
59296140 type DetachGroupPolicyInput struct {
59306141 // The name (friendly name, not ARN) of the group to detach the policy from.
5931 GroupName *string `type:"string" required:"true"`
6142 GroupName *string `min:"1" type:"string" required:"true"`
59326143
59336144 // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
59346145 //
59356146 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
59366147 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
59376148 // in the AWS General Reference.
5938 PolicyArn *string `type:"string" required:"true"`
6149 PolicyArn *string `min:"20" type:"string" required:"true"`
59396150
59406151 metadataDetachGroupPolicyInput `json:"-" xml:"-"`
59416152 }
59786189 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
59796190 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
59806191 // in the AWS General Reference.
5981 PolicyArn *string `type:"string" required:"true"`
6192 PolicyArn *string `min:"20" type:"string" required:"true"`
59826193
59836194 // The name (friendly name, not ARN) of the role to detach the policy from.
5984 RoleName *string `type:"string" required:"true"`
6195 RoleName *string `min:"1" type:"string" required:"true"`
59856196
59866197 metadataDetachRolePolicyInput `json:"-" xml:"-"`
59876198 }
60246235 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
60256236 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
60266237 // in the AWS General Reference.
6027 PolicyArn *string `type:"string" required:"true"`
6238 PolicyArn *string `min:"20" type:"string" required:"true"`
60286239
60296240 // The name (friendly name, not ARN) of the user to detach the policy from.
6030 UserName *string `type:"string" required:"true"`
6241 UserName *string `min:"1" type:"string" required:"true"`
60316242
60326243 metadataDetachUserPolicyInput `json:"-" xml:"-"`
60336244 }
60666277
60676278 type EnableMFADeviceInput struct {
60686279 // An authentication code emitted by the device.
6069 AuthenticationCode1 *string `type:"string" required:"true"`
6280 AuthenticationCode1 *string `min:"6" type:"string" required:"true"`
60706281
60716282 // A subsequent authentication code emitted by the device.
6072 AuthenticationCode2 *string `type:"string" required:"true"`
6283 AuthenticationCode2 *string `min:"6" type:"string" required:"true"`
60736284
60746285 // The serial number that uniquely identifies the MFA device. For virtual MFA
60756286 // devices, the serial number is the device ARN.
6076 SerialNumber *string `type:"string" required:"true"`
6287 SerialNumber *string `min:"9" type:"string" required:"true"`
60776288
60786289 // The name of the user for whom you want to enable the MFA device.
6079 UserName *string `type:"string" required:"true"`
6290 UserName *string `min:"1" type:"string" required:"true"`
60806291
60816292 metadataEnableMFADeviceInput `json:"-" xml:"-"`
60826293 }
61106321
61116322 // GoString returns the string representation
61126323 func (s EnableMFADeviceOutput) GoString() string {
6324 return s.String()
6325 }
6326
6327 // Contains the results of a simulation.
6328 //
6329 // This data type is used by the return parameter of SimulatePolicy.
6330 type EvaluationResult struct {
6331 // The name of the API action tested on the indicated resource.
6332 EvalActionName *string `min:"3" type:"string" required:"true"`
6333
6334 // The result of the simulation.
6335 EvalDecision *string `type:"string" required:"true" enum:"PolicyEvaluationDecisionType"`
6336
6337 // The ARN of the resource that the indicated API action was tested on.
6338 EvalResourceName *string `min:"1" type:"string" required:"true"`
6339
6340 // A list of the statements in the input policies that determine the result
6341 // for this scenario. Remember that even if multiple statements allow the action
6342 // on the resource, if only one statement denies that action, then the explicit
6343 // deny overrides any allow, and the deny statement is the only entry included
6344 // in the result.
6345 MatchedStatements []*Statement `type:"list"`
6346
6347 // A list of context keys that are required by the included input policies but
6348 // that were not provided by one of the input parameters. To discover the context
6349 // keys used by a set of policies, you can call GetContextKeysForCustomPolicy
6350 // or GetContextKeysForPrincipalPolicy.
6351 //
6352 // If the response includes any keys in this list, then the reported results
6353 // might be untrustworthy because the simulation could not completely evaluate
6354 // all of the conditions specified in the policies that would occur in a real
6355 // world request.
6356 MissingContextValues []*string `type:"list"`
6357
6358 metadataEvaluationResult `json:"-" xml:"-"`
6359 }
6360
6361 type metadataEvaluationResult struct {
6362 SDKShapeTraits bool `type:"structure"`
6363 }
6364
6365 // String returns the string representation
6366 func (s EvaluationResult) String() string {
6367 return awsutil.Prettify(s)
6368 }
6369
6370 // GoString returns the string representation
6371 func (s EvaluationResult) GoString() string {
61136372 return s.String()
61146373 }
61156374
61586417
61596418 type GetAccessKeyLastUsedInput struct {
61606419 // The identifier of an access key.
6161 AccessKeyId *string `type:"string" required:"true"`
6420 AccessKeyId *string `min:"16" type:"string" required:"true"`
61626421
61636422 metadataGetAccessKeyLastUsedInput `json:"-" xml:"-"`
61646423 }
61856444 AccessKeyLastUsed *AccessKeyLastUsed `type:"structure"`
61866445
61876446 // The name of the AWS IAM user that owns this access key.
6188 UserName *string `type:"string"`
6447 UserName *string `min:"1" type:"string"`
61896448
61906449 metadataGetAccessKeyLastUsedOutput `json:"-" xml:"-"`
61916450 }
62096468 // policy) for filtering the results.
62106469 Filter []*string `type:"list"`
62116470
6212 // Use this parameter only when paginating results and only after you have received
6213 // a response where the results are truncated. Set it to the value of the Marker
6214 // element in the response you just received.
6215 Marker *string `type:"string"`
6471 // Use this parameter only when paginating results and only after you receive
6472 // a response indicating that the results are truncated. Set it to the value
6473 // of the Marker element in the response you received to inform the next call
6474 // about where to start.
6475 Marker *string `min:"1" type:"string"`
62166476
62176477 // Use this only when paginating results to indicate the maximum number of items
62186478 // you want in the response. If there are additional items beyond the maximum
62196479 // you specify, the IsTruncated response element is true.
62206480 //
62216481 // This parameter is optional. If you do not include it, it defaults to 100.
6222 MaxItems *int64 `type:"integer"`
6482 // Note that IAM might return fewer results, even when there are more results
6483 // available. If this is the case, the IsTruncated response element returns
6484 // true and Marker contains a value to include in the subsequent call that tells
6485 // the service where to continue from.
6486 MaxItems *int64 `min:"1" type:"integer"`
62236487
62246488 metadataGetAccountAuthorizationDetailsInput `json:"-" xml:"-"`
62256489 }
62456509
62466510 // A flag that indicates whether there are more items to return. If your results
62476511 // were truncated, you can make a subsequent pagination request using the Marker
6248 // request parameter to retrieve more items.
6512 // request parameter to retrieve more items. Note that IAM might return fewer
6513 // than the MaxItems number of results even when there are more results available.
6514 // We recommend that you check IsTruncated after every call to ensure that you
6515 // receive all of your results.
62496516 IsTruncated *bool `type:"boolean"`
62506517
62516518 // When IsTruncated is true, this element is present and contains the value
62526519 // to use for the Marker parameter in a subsequent pagination request.
6253 Marker *string `type:"string"`
6520 Marker *string `min:"1" type:"string"`
62546521
62556522 // A list containing information about managed policies.
62566523 Policies []*ManagedPolicyDetail `type:"list"`
65036770 return s.String()
65046771 }
65056772
6773 type GetContextKeysForCustomPolicyInput struct {
6774 // A list of policies for which you want list of context keys used in Condition
6775 // elements.
6776 PolicyInputList []*string `type:"list" required:"true"`
6777
6778 metadataGetContextKeysForCustomPolicyInput `json:"-" xml:"-"`
6779 }
6780
6781 type metadataGetContextKeysForCustomPolicyInput struct {
6782 SDKShapeTraits bool `type:"structure"`
6783 }
6784
6785 // String returns the string representation
6786 func (s GetContextKeysForCustomPolicyInput) String() string {
6787 return awsutil.Prettify(s)
6788 }
6789
6790 // GoString returns the string representation
6791 func (s GetContextKeysForCustomPolicyInput) GoString() string {
6792 return s.String()
6793 }
6794
6795 // Contains the response to a successful GetContextKeysForPrincipalPolicy or
6796 // GetContextKeysForCustomPolicy request.
6797 type GetContextKeysForPolicyResponse struct {
6798 // The list of context keys that are used in the Condition elements of the input
6799 // policies.
6800 ContextKeyNames []*string `type:"list"`
6801
6802 metadataGetContextKeysForPolicyResponse `json:"-" xml:"-"`
6803 }
6804
6805 type metadataGetContextKeysForPolicyResponse struct {
6806 SDKShapeTraits bool `type:"structure"`
6807 }
6808
6809 // String returns the string representation
6810 func (s GetContextKeysForPolicyResponse) String() string {
6811 return awsutil.Prettify(s)
6812 }
6813
6814 // GoString returns the string representation
6815 func (s GetContextKeysForPolicyResponse) GoString() string {
6816 return s.String()
6817 }
6818
6819 type GetContextKeysForPrincipalPolicyInput struct {
6820 // A optional list of additional policies for which you want list of context
6821 // keys used in Condition elements.
6822 PolicyInputList []*string `type:"list"`
6823
6824 // The ARN of a user, group, or role whose policies contain the context keys
6825 // that you want listed. If you specify a user, the list includes context keys
6826 // that are found in all policies attached to the user as well as to all groups
6827 // that the user is a member of. If you pick a group or a role, then it includes
6828 // only those context keys that are found in policies attached to that entity.
6829 // Note that all parameters are shown in unencoded form here for clarity, but
6830 // must be URL encoded to be included as a part of a real HTML request.
6831 PolicySourceArn *string `min:"20" type:"string" required:"true"`
6832
6833 metadataGetContextKeysForPrincipalPolicyInput `json:"-" xml:"-"`
6834 }
6835
6836 type metadataGetContextKeysForPrincipalPolicyInput struct {
6837 SDKShapeTraits bool `type:"structure"`
6838 }
6839
6840 // String returns the string representation
6841 func (s GetContextKeysForPrincipalPolicyInput) String() string {
6842 return awsutil.Prettify(s)
6843 }
6844
6845 // GoString returns the string representation
6846 func (s GetContextKeysForPrincipalPolicyInput) GoString() string {
6847 return s.String()
6848 }
6849
65066850 type GetCredentialReportInput struct {
65076851 metadataGetCredentialReportInput `json:"-" xml:"-"`
65086852 }
65526896
65536897 type GetGroupInput struct {
65546898 // The name of the group.
6555 GroupName *string `type:"string" required:"true"`
6556
6557 // Use this parameter only when paginating results and only after you have received
6558 // a response where the results are truncated. Set it to the value of the Marker
6559 // element in the response you just received.
6560 Marker *string `type:"string"`
6899 GroupName *string `min:"1" type:"string" required:"true"`
6900
6901 // Use this parameter only when paginating results and only after you receive
6902 // a response indicating that the results are truncated. Set it to the value
6903 // of the Marker element in the response you received to inform the next call
6904 // about where to start.
6905 Marker *string `min:"1" type:"string"`
65616906
65626907 // Use this only when paginating results to indicate the maximum number of items
65636908 // you want in the response. If there are additional items beyond the maximum
65646909 // you specify, the IsTruncated response element is true.
65656910 //
65666911 // This parameter is optional. If you do not include it, it defaults to 100.
6567 MaxItems *int64 `type:"integer"`
6912 // Note that IAM might return fewer results, even when there are more results
6913 // available. If this is the case, the IsTruncated response element returns
6914 // true and Marker contains a value to include in the subsequent call that tells
6915 // the service where to continue from.
6916 MaxItems *int64 `min:"1" type:"integer"`
65686917
65696918 metadataGetGroupInput `json:"-" xml:"-"`
65706919 }
65906939
65916940 // A flag that indicates whether there are more items to return. If your results
65926941 // were truncated, you can make a subsequent pagination request using the Marker
6593 // request parameter to retrieve more items.
6942 // request parameter to retrieve more items. Note that IAM might return fewer
6943 // than the MaxItems number of results even when there are more results available.
6944 // We recommend that you check IsTruncated after every call to ensure that you
6945 // receive all of your results.
65946946 IsTruncated *bool `type:"boolean"`
65956947
65966948 // When IsTruncated is true, this element is present and contains the value
65976949 // to use for the Marker parameter in a subsequent pagination request.
6598 Marker *string `type:"string"`
6950 Marker *string `min:"1" type:"string"`
65996951
66006952 // A list of users in the group.
66016953 Users []*User `type:"list" required:"true"`
66196971
66206972 type GetGroupPolicyInput struct {
66216973 // The name of the group the policy is associated with.
6622 GroupName *string `type:"string" required:"true"`
6974 GroupName *string `min:"1" type:"string" required:"true"`
66236975
66246976 // The name of the policy document to get.
6625 PolicyName *string `type:"string" required:"true"`
6977 PolicyName *string `min:"1" type:"string" required:"true"`
66266978
66276979 metadataGetGroupPolicyInput `json:"-" xml:"-"`
66286980 }
66446996 // Contains the response to a successful GetGroupPolicy request.
66456997 type GetGroupPolicyOutput struct {
66466998 // The group the policy is associated with.
6647 GroupName *string `type:"string" required:"true"`
6999 GroupName *string `min:"1" type:"string" required:"true"`
66487000
66497001 // The policy document.
6650 PolicyDocument *string `type:"string" required:"true"`
7002 PolicyDocument *string `min:"1" type:"string" required:"true"`
66517003
66527004 // The name of the policy.
6653 PolicyName *string `type:"string" required:"true"`
7005 PolicyName *string `min:"1" type:"string" required:"true"`
66547006
66557007 metadataGetGroupPolicyOutput `json:"-" xml:"-"`
66567008 }
66717023
66727024 type GetInstanceProfileInput struct {
66737025 // The name of the instance profile to get information about.
6674 InstanceProfileName *string `type:"string" required:"true"`
7026 InstanceProfileName *string `min:"1" type:"string" required:"true"`
66757027
66767028 metadataGetInstanceProfileInput `json:"-" xml:"-"`
66777029 }
67147066
67157067 type GetLoginProfileInput struct {
67167068 // The name of the user whose login profile you want to retrieve.
6717 UserName *string `type:"string" required:"true"`
7069 UserName *string `min:"1" type:"string" required:"true"`
67187070
67197071 metadataGetLoginProfileInput `json:"-" xml:"-"`
67207072 }
67597111 // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider
67607112 // to get information for. You can get a list of OIDC provider ARNs by using
67617113 // the ListOpenIDConnectProviders action.
6762 OpenIDConnectProviderArn *string `type:"string" required:"true"`
7114 OpenIDConnectProviderArn *string `min:"20" type:"string" required:"true"`
67637115
67647116 metadataGetOpenIDConnectProviderInput `json:"-" xml:"-"`
67657117 }
67947146
67957147 // The URL that the IAM OpenID Connect provider is associated with. For more
67967148 // information, see CreateOpenIDConnectProvider.
6797 Url *string `type:"string"`
7149 Url *string `min:"1" type:"string"`
67987150
67997151 metadataGetOpenIDConnectProviderOutput `json:"-" xml:"-"`
68007152 }
68197171 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
68207172 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
68217173 // in the AWS General Reference.
6822 PolicyArn *string `type:"string" required:"true"`
7174 PolicyArn *string `min:"20" type:"string" required:"true"`
68237175
68247176 metadataGetPolicyInput `json:"-" xml:"-"`
68257177 }
68667218 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
68677219 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
68687220 // in the AWS General Reference.
6869 PolicyArn *string `type:"string" required:"true"`
7221 PolicyArn *string `min:"20" type:"string" required:"true"`
68707222
68717223 // Identifies the policy version to retrieve.
68727224 VersionId *string `type:"string" required:"true"`
68947246 //
68957247 // For more information about managed policy versions, see Versioning for Managed
68967248 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
6897 // in the Using IAM guide.
7249 // in the IAM User Guide.
68987250 PolicyVersion *PolicyVersion `type:"structure"`
68997251
69007252 metadataGetPolicyVersionOutput `json:"-" xml:"-"`
69167268
69177269 type GetRoleInput struct {
69187270 // The name of the role to get information about.
6919 RoleName *string `type:"string" required:"true"`
7271 RoleName *string `min:"1" type:"string" required:"true"`
69207272
69217273 metadataGetRoleInput `json:"-" xml:"-"`
69227274 }
69597311
69607312 type GetRolePolicyInput struct {
69617313 // The name of the policy document to get.
6962 PolicyName *string `type:"string" required:"true"`
7314 PolicyName *string `min:"1" type:"string" required:"true"`
69637315
69647316 // The name of the role associated with the policy.
6965 RoleName *string `type:"string" required:"true"`
7317 RoleName *string `min:"1" type:"string" required:"true"`
69667318
69677319 metadataGetRolePolicyInput `json:"-" xml:"-"`
69687320 }
69847336 // Contains the response to a successful GetRolePolicy request.
69857337 type GetRolePolicyOutput struct {
69867338 // The policy document.
6987 PolicyDocument *string `type:"string" required:"true"`
7339 PolicyDocument *string `min:"1" type:"string" required:"true"`
69887340
69897341 // The name of the policy.
6990 PolicyName *string `type:"string" required:"true"`
7342 PolicyName *string `min:"1" type:"string" required:"true"`
69917343
69927344 // The role the policy is associated with.
6993 RoleName *string `type:"string" required:"true"`
7345 RoleName *string `min:"1" type:"string" required:"true"`
69947346
69957347 metadataGetRolePolicyOutput `json:"-" xml:"-"`
69967348 }
70117363
70127364 type GetSAMLProviderInput struct {
70137365 // The Amazon Resource Name (ARN) of the SAML provider to get information about.
7014 SAMLProviderArn *string `type:"string" required:"true"`
7366 SAMLProviderArn *string `min:"20" type:"string" required:"true"`
70157367
70167368 metadataGetSAMLProviderInput `json:"-" xml:"-"`
70177369 }
70367388 CreateDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
70377389
70387390 // The XML metadata document that includes information about an identity provider.
7039 SAMLMetadataDocument *string `type:"string"`
7391 SAMLMetadataDocument *string `min:"1000" type:"string"`
70407392
70417393 // The expiration date and time for the SAML provider.
70427394 ValidUntil *time.Time `type:"timestamp" timestampFormat:"iso8601"`
70657417 Encoding *string `type:"string" required:"true" enum:"encodingType"`
70667418
70677419 // The unique identifier for the SSH public key.
7068 SSHPublicKeyId *string `type:"string" required:"true"`
7420 SSHPublicKeyId *string `min:"20" type:"string" required:"true"`
70697421
70707422 // The name of the IAM user associated with the SSH public key.
7071 UserName *string `type:"string" required:"true"`
7423 UserName *string `min:"1" type:"string" required:"true"`
70727424
70737425 metadataGetSSHPublicKeyInput `json:"-" xml:"-"`
70747426 }
71117463
71127464 type GetServerCertificateInput struct {
71137465 // The name of the server certificate you want to retrieve information about.
7114 ServerCertificateName *string `type:"string" required:"true"`
7466 ServerCertificateName *string `min:"1" type:"string" required:"true"`
71157467
71167468 metadataGetServerCertificateInput `json:"-" xml:"-"`
71177469 }
71577509 //
71587510 // This parameter is optional. If it is not included, it defaults to the user
71597511 // making the request.
7160 UserName *string `type:"string"`
7512 UserName *string `min:"1" type:"string"`
71617513
71627514 metadataGetUserInput `json:"-" xml:"-"`
71637515 }
72007552
72017553 type GetUserPolicyInput struct {
72027554 // The name of the policy document to get.
7203 PolicyName *string `type:"string" required:"true"`
7555 PolicyName *string `min:"1" type:"string" required:"true"`
72047556
72057557 // The name of the user who the policy is associated with.
7206 UserName *string `type:"string" required:"true"`
7558 UserName *string `min:"1" type:"string" required:"true"`
72077559
72087560 metadataGetUserPolicyInput `json:"-" xml:"-"`
72097561 }
72257577 // Contains the response to a successful GetUserPolicy request.
72267578 type GetUserPolicyOutput struct {
72277579 // The policy document.
7228 PolicyDocument *string `type:"string" required:"true"`
7580 PolicyDocument *string `min:"1" type:"string" required:"true"`
72297581
72307582 // The name of the policy.
7231 PolicyName *string `type:"string" required:"true"`
7583 PolicyName *string `min:"1" type:"string" required:"true"`
72327584
72337585 // The user the policy is associated with.
7234 UserName *string `type:"string" required:"true"`
7586 UserName *string `min:"1" type:"string" required:"true"`
72357587
72367588 metadataGetUserPolicyOutput `json:"-" xml:"-"`
72377589 }
72597611 // The Amazon Resource Name (ARN) specifying the group. For more information
72607612 // about ARNs and how to use them in policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
72617613 // in the Using IAM guide.
7262 Arn *string `type:"string" required:"true"`
7614 Arn *string `min:"20" type:"string" required:"true"`
72637615
72647616 // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),
72657617 // when the group was created.
72687620 // The stable and unique string identifying the group. For more information
72697621 // about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
72707622 // in the Using IAM guide.
7271 GroupId *string `type:"string" required:"true"`
7623 GroupId *string `min:"16" type:"string" required:"true"`
72727624
72737625 // The friendly name that identifies the group.
7274 GroupName *string `type:"string" required:"true"`
7626 GroupName *string `min:"1" type:"string" required:"true"`
72757627
72767628 // The path to the group. For more information about paths, see IAM Identifiers
72777629 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
72787630 // in the Using IAM guide.
7279 Path *string `type:"string" required:"true"`
7631 Path *string `min:"1" type:"string" required:"true"`
72807632
72817633 metadataGroup `json:"-" xml:"-"`
72827634 }
73057657 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
73067658 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
73077659 // in the AWS General Reference.
7308 Arn *string `type:"string"`
7660 Arn *string `min:"20" type:"string"`
73097661
73107662 // A list of the managed policies attached to the group.
73117663 AttachedManagedPolicies []*AttachedPolicy `type:"list"`
73177669 // The stable and unique string identifying the group. For more information
73187670 // about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
73197671 // in the Using IAM guide.
7320 GroupId *string `type:"string"`
7672 GroupId *string `min:"16" type:"string"`
73217673
73227674 // The friendly name that identifies the group.
7323 GroupName *string `type:"string"`
7675 GroupName *string `min:"1" type:"string"`
73247676
73257677 // A list of the inline policies embedded in the group.
73267678 GroupPolicyList []*PolicyDetail `type:"list"`
73287680 // The path to the group. For more information about paths, see IAM Identifiers
73297681 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
73307682 // in the Using IAM guide.
7331 Path *string `type:"string"`
7683 Path *string `min:"1" type:"string"`
73327684
73337685 metadataGroupDetail `json:"-" xml:"-"`
73347686 }
73637715 // information about ARNs and how to use them in policies, see IAM Identifiers
73647716 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
73657717 // in the Using IAM guide.
7366 Arn *string `type:"string" required:"true"`
7718 Arn *string `min:"20" type:"string" required:"true"`
73677719
73687720 // The date when the instance profile was created.
73697721 CreateDate *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
73717723 // The stable and unique string identifying the instance profile. For more information
73727724 // about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
73737725 // in the Using IAM guide.
7374 InstanceProfileId *string `type:"string" required:"true"`
7726 InstanceProfileId *string `min:"16" type:"string" required:"true"`
73757727
73767728 // The name identifying the instance profile.
7377 InstanceProfileName *string `type:"string" required:"true"`
7729 InstanceProfileName *string `min:"1" type:"string" required:"true"`
73787730
73797731 // The path to the instance profile. For more information about paths, see IAM
73807732 // Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
73817733 // in the Using IAM guide.
7382 Path *string `type:"string" required:"true"`
7734 Path *string `min:"1" type:"string" required:"true"`
73837735
73847736 // The role associated with the instance profile.
73857737 Roles []*Role `type:"list" required:"true"`
74027754 }
74037755
74047756 type ListAccessKeysInput struct {
7405 // Use this parameter only when paginating results and only after you have received
7406 // a response where the results are truncated. Set it to the value of the Marker
7407 // element in the response you just received.
7408 Marker *string `type:"string"`
7757 // Use this parameter only when paginating results and only after you receive
7758 // a response indicating that the results are truncated. Set it to the value
7759 // of the Marker element in the response you received to inform the next call
7760 // about where to start.
7761 Marker *string `min:"1" type:"string"`
74097762
74107763 // Use this only when paginating results to indicate the maximum number of items
74117764 // you want in the response. If there are additional items beyond the maximum
74127765 // you specify, the IsTruncated response element is true.
74137766 //
74147767 // This parameter is optional. If you do not include it, it defaults to 100.
7415 MaxItems *int64 `type:"integer"`
7768 // Note that IAM might return fewer results, even when there are more results
7769 // available. If this is the case, the IsTruncated response element returns
7770 // true and Marker contains a value to include in the subsequent call that tells
7771 // the service where to continue from.
7772 MaxItems *int64 `min:"1" type:"integer"`
74167773
74177774 // The name of the user.
7418 UserName *string `type:"string"`
7775 UserName *string `min:"1" type:"string"`
74197776
74207777 metadataListAccessKeysInput `json:"-" xml:"-"`
74217778 }
74417798
74427799 // A flag that indicates whether there are more items to return. If your results
74437800 // were truncated, you can make a subsequent pagination request using the Marker
7444 // request parameter to retrieve more items.
7801 // request parameter to retrieve more items. Note that IAM might return fewer
7802 // than the MaxItems number of results even when there are more results available.
7803 // We recommend that you check IsTruncated after every call to ensure that you
7804 // receive all of your results.
74457805 IsTruncated *bool `type:"boolean"`
74467806
74477807 // When IsTruncated is true, this element is present and contains the value
74487808 // to use for the Marker parameter in a subsequent pagination request.
7449 Marker *string `type:"string"`
7809 Marker *string `min:"1" type:"string"`
74507810
74517811 metadataListAccessKeysOutput `json:"-" xml:"-"`
74527812 }
74667826 }
74677827
74687828 type ListAccountAliasesInput struct {
7469 // Use this parameter only when paginating results and only after you have received
7470 // a response where the results are truncated. Set it to the value of the Marker
7471 // element in the response you just received.
7472 Marker *string `type:"string"`
7829 // Use this parameter only when paginating results and only after you receive
7830 // a response indicating that the results are truncated. Set it to the value
7831 // of the Marker element in the response you received to inform the next call
7832 // about where to start.
7833 Marker *string `min:"1" type:"string"`
74737834
74747835 // Use this only when paginating results to indicate the maximum number of items
74757836 // you want in the response. If there are additional items beyond the maximum
74767837 // you specify, the IsTruncated response element is true.
74777838 //
74787839 // This parameter is optional. If you do not include it, it defaults to 100.
7479 MaxItems *int64 `type:"integer"`
7840 // Note that IAM might return fewer results, even when there are more results
7841 // available. If this is the case, the IsTruncated response element returns
7842 // true and Marker contains a value to include in the subsequent call that tells
7843 // the service where to continue from.
7844 MaxItems *int64 `min:"1" type:"integer"`
74807845
74817846 metadataListAccountAliasesInput `json:"-" xml:"-"`
74827847 }
75027867
75037868 // A flag that indicates whether there are more items to return. If your results
75047869 // were truncated, you can make a subsequent pagination request using the Marker
7505 // request parameter to retrieve more items.
7870 // request parameter to retrieve more items. Note that IAM might return fewer
7871 // than the MaxItems number of results even when there are more results available.
7872 // We recommend that you check IsTruncated after every call to ensure that you
7873 // receive all of your results.
75067874 IsTruncated *bool `type:"boolean"`
75077875
75087876 // When IsTruncated is true, this element is present and contains the value
75097877 // to use for the Marker parameter in a subsequent pagination request.
7510 Marker *string `type:"string"`
7878 Marker *string `min:"1" type:"string"`
75117879
75127880 metadataListAccountAliasesOutput `json:"-" xml:"-"`
75137881 }
75297897 type ListAttachedGroupPoliciesInput struct {
75307898 // The name (friendly name, not ARN) of the group to list attached policies
75317899 // for.
7532 GroupName *string `type:"string" required:"true"`
7533
7534 // Use this parameter only when paginating results and only after you have received
7535 // a response where the results are truncated. Set it to the value of the Marker
7536 // element in the response you just received.
7537 Marker *string `type:"string"`
7900 GroupName *string `min:"1" type:"string" required:"true"`
7901
7902 // Use this parameter only when paginating results and only after you receive
7903 // a response indicating that the results are truncated. Set it to the value
7904 // of the Marker element in the response you received to inform the next call
7905 // about where to start.
7906 Marker *string `min:"1" type:"string"`
75387907
75397908 // Use this only when paginating results to indicate the maximum number of items
75407909 // you want in the response. If there are additional items beyond the maximum
75417910 // you specify, the IsTruncated response element is true.
75427911 //
75437912 // This parameter is optional. If you do not include it, it defaults to 100.
7544 MaxItems *int64 `type:"integer"`
7913 // Note that IAM might return fewer results, even when there are more results
7914 // available. If this is the case, the IsTruncated response element returns
7915 // true and Marker contains a value to include in the subsequent call that tells
7916 // the service where to continue from.
7917 MaxItems *int64 `min:"1" type:"integer"`
75457918
75467919 // The path prefix for filtering the results. This parameter is optional. If
75477920 // it is not included, it defaults to a slash (/), listing all policies.
75717944
75727945 // A flag that indicates whether there are more items to return. If your results
75737946 // were truncated, you can make a subsequent pagination request using the Marker
7574 // request parameter to retrieve more items.
7947 // request parameter to retrieve more items. Note that IAM might return fewer
7948 // than the MaxItems number of results even when there are more results available.
7949 // We recommend that you check IsTruncated after every call to ensure that you
7950 // receive all of your results.
75757951 IsTruncated *bool `type:"boolean"`
75767952
75777953 // When IsTruncated is true, this element is present and contains the value
75787954 // to use for the Marker parameter in a subsequent pagination request.
7579 Marker *string `type:"string"`
7955 Marker *string `min:"1" type:"string"`
75807956
75817957 metadataListAttachedGroupPoliciesOutput `json:"-" xml:"-"`
75827958 }
75967972 }
75977973
75987974 type ListAttachedRolePoliciesInput struct {
7599 // Use this parameter only when paginating results and only after you have received
7600 // a response where the results are truncated. Set it to the value of the Marker
7601 // element in the response you just received.
7602 Marker *string `type:"string"`
7975 // Use this parameter only when paginating results and only after you receive
7976 // a response indicating that the results are truncated. Set it to the value
7977 // of the Marker element in the response you received to inform the next call
7978 // about where to start.
7979 Marker *string `min:"1" type:"string"`
76037980
76047981 // Use this only when paginating results to indicate the maximum number of items
76057982 // you want in the response. If there are additional items beyond the maximum
76067983 // you specify, the IsTruncated response element is true.
76077984 //
76087985 // This parameter is optional. If you do not include it, it defaults to 100.
7609 MaxItems *int64 `type:"integer"`
7986 // Note that IAM might return fewer results, even when there are more results
7987 // available. If this is the case, the IsTruncated response element returns
7988 // true and Marker contains a value to include in the subsequent call that tells
7989 // the service where to continue from.
7990 MaxItems *int64 `min:"1" type:"integer"`
76107991
76117992 // The path prefix for filtering the results. This parameter is optional. If
76127993 // it is not included, it defaults to a slash (/), listing all policies.
76137994 PathPrefix *string `type:"string"`
76147995
76157996 // The name (friendly name, not ARN) of the role to list attached policies for.
7616 RoleName *string `type:"string" required:"true"`
7997 RoleName *string `min:"1" type:"string" required:"true"`
76177998
76187999 metadataListAttachedRolePoliciesInput `json:"-" xml:"-"`
76198000 }
76398020
76408021 // A flag that indicates whether there are more items to return. If your results
76418022 // were truncated, you can make a subsequent pagination request using the Marker
7642 // request parameter to retrieve more items.
8023 // request parameter to retrieve more items. Note that IAM might return fewer
8024 // than the MaxItems number of results even when there are more results available.
8025 // We recommend that you check IsTruncated after every call to ensure that you
8026 // receive all of your results.
76438027 IsTruncated *bool `type:"boolean"`
76448028
76458029 // When IsTruncated is true, this element is present and contains the value
76468030 // to use for the Marker parameter in a subsequent pagination request.
7647 Marker *string `type:"string"`
8031 Marker *string `min:"1" type:"string"`
76488032
76498033 metadataListAttachedRolePoliciesOutput `json:"-" xml:"-"`
76508034 }
76648048 }
76658049
76668050 type ListAttachedUserPoliciesInput struct {
7667 // Use this parameter only when paginating results and only after you have received
7668 // a response where the results are truncated. Set it to the value of the Marker
7669 // element in the response you just received.
7670 Marker *string `type:"string"`
8051 // Use this parameter only when paginating results and only after you receive
8052 // a response indicating that the results are truncated. Set it to the value
8053 // of the Marker element in the response you received to inform the next call
8054 // about where to start.
8055 Marker *string `min:"1" type:"string"`
76718056
76728057 // Use this only when paginating results to indicate the maximum number of items
76738058 // you want in the response. If there are additional items beyond the maximum
76748059 // you specify, the IsTruncated response element is true.
76758060 //
76768061 // This parameter is optional. If you do not include it, it defaults to 100.
7677 MaxItems *int64 `type:"integer"`
8062 // Note that IAM might return fewer results, even when there are more results
8063 // available. If this is the case, the IsTruncated response element returns
8064 // true and Marker contains a value to include in the subsequent call that tells
8065 // the service where to continue from.
8066 MaxItems *int64 `min:"1" type:"integer"`
76788067
76798068 // The path prefix for filtering the results. This parameter is optional. If
76808069 // it is not included, it defaults to a slash (/), listing all policies.
76818070 PathPrefix *string `type:"string"`
76828071
76838072 // The name (friendly name, not ARN) of the user to list attached policies for.
7684 UserName *string `type:"string" required:"true"`
8073 UserName *string `min:"1" type:"string" required:"true"`
76858074
76868075 metadataListAttachedUserPoliciesInput `json:"-" xml:"-"`
76878076 }
77078096
77088097 // A flag that indicates whether there are more items to return. If your results
77098098 // were truncated, you can make a subsequent pagination request using the Marker
7710 // request parameter to retrieve more items.
8099 // request parameter to retrieve more items. Note that IAM might return fewer
8100 // than the MaxItems number of results even when there are more results available.
8101 // We recommend that you check IsTruncated after every call to ensure that you
8102 // receive all of your results.
77118103 IsTruncated *bool `type:"boolean"`
77128104
77138105 // When IsTruncated is true, this element is present and contains the value
77148106 // to use for the Marker parameter in a subsequent pagination request.
7715 Marker *string `type:"string"`
8107 Marker *string `min:"1" type:"string"`
77168108
77178109 metadataListAttachedUserPoliciesOutput `json:"-" xml:"-"`
77188110 }
77398131 // not included, all attached entities (users, groups, and roles) are returned.
77408132 EntityFilter *string `type:"string" enum:"EntityType"`
77418133
7742 // Use this parameter only when paginating results and only after you have received
7743 // a response where the results are truncated. Set it to the value of the Marker
7744 // element in the response you just received.
7745 Marker *string `type:"string"`
8134 // Use this parameter only when paginating results and only after you receive
8135 // a response indicating that the results are truncated. Set it to the value
8136 // of the Marker element in the response you received to inform the next call
8137 // about where to start.
8138 Marker *string `min:"1" type:"string"`
77468139
77478140 // Use this only when paginating results to indicate the maximum number of items
77488141 // you want in the response. If there are additional items beyond the maximum
77498142 // you specify, the IsTruncated response element is true.
77508143 //
77518144 // This parameter is optional. If you do not include it, it defaults to 100.
7752 MaxItems *int64 `type:"integer"`
8145 // Note that IAM might return fewer results, even when there are more results
8146 // available. If this is the case, the IsTruncated response element returns
8147 // true and Marker contains a value to include in the subsequent call that tells
8148 // the service where to continue from.
8149 MaxItems *int64 `min:"1" type:"integer"`
77538150
77548151 // The path prefix for filtering the results. This parameter is optional. If
77558152 // it is not included, it defaults to a slash (/), listing all entities.
7756 PathPrefix *string `type:"string"`
8153 PathPrefix *string `min:"1" type:"string"`
77578154
77588155 // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
77598156 //
77608157 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
77618158 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
77628159 // in the AWS General Reference.
7763 PolicyArn *string `type:"string" required:"true"`
8160 PolicyArn *string `min:"20" type:"string" required:"true"`
77648161
77658162 metadataListEntitiesForPolicyInput `json:"-" xml:"-"`
77668163 }
77838180 type ListEntitiesForPolicyOutput struct {
77848181 // A flag that indicates whether there are more items to return. If your results
77858182 // were truncated, you can make a subsequent pagination request using the Marker
7786 // request parameter to retrieve more items.
8183 // request parameter to retrieve more items. Note that IAM might return fewer
8184 // than the MaxItems number of results even when there are more results available.
8185 // We recommend that you check IsTruncated after every call to ensure that you
8186 // receive all of your results.
77878187 IsTruncated *bool `type:"boolean"`
77888188
77898189 // When IsTruncated is true, this element is present and contains the value
77908190 // to use for the Marker parameter in a subsequent pagination request.
7791 Marker *string `type:"string"`
8191 Marker *string `min:"1" type:"string"`
77928192
77938193 // A list of groups that the policy is attached to.
77948194 PolicyGroups []*PolicyGroup `type:"list"`
78188218
78198219 type ListGroupPoliciesInput struct {
78208220 // The name of the group to list policies for.
7821 GroupName *string `type:"string" required:"true"`
7822
7823 // Use this parameter only when paginating results and only after you have received
7824 // a response where the results are truncated. Set it to the value of the Marker
7825 // element in the response you just received.
7826 Marker *string `type:"string"`
8221 GroupName *string `min:"1" type:"string" required:"true"`
8222
8223 // Use this parameter only when paginating results and only after you receive
8224 // a response indicating that the results are truncated. Set it to the value
8225 // of the Marker element in the response you received to inform the next call
8226 // about where to start.
8227 Marker *string `min:"1" type:"string"`
78278228
78288229 // Use this only when paginating results to indicate the maximum number of items
78298230 // you want in the response. If there are additional items beyond the maximum
78308231 // you specify, the IsTruncated response element is true.
78318232 //
78328233 // This parameter is optional. If you do not include it, it defaults to 100.
7833 MaxItems *int64 `type:"integer"`
8234 // Note that IAM might return fewer results, even when there are more results
8235 // available. If this is the case, the IsTruncated response element returns
8236 // true and Marker contains a value to include in the subsequent call that tells
8237 // the service where to continue from.
8238 MaxItems *int64 `min:"1" type:"integer"`
78348239
78358240 metadataListGroupPoliciesInput `json:"-" xml:"-"`
78368241 }
78538258 type ListGroupPoliciesOutput struct {
78548259 // A flag that indicates whether there are more items to return. If your results
78558260 // were truncated, you can make a subsequent pagination request using the Marker
7856 // request parameter to retrieve more items.
8261 // request parameter to retrieve more items. Note that IAM might return fewer
8262 // than the MaxItems number of results even when there are more results available.
8263 // We recommend that you check IsTruncated after every call to ensure that you
8264 // receive all of your results.
78578265 IsTruncated *bool `type:"boolean"`
78588266
78598267 // When IsTruncated is true, this element is present and contains the value
78608268 // to use for the Marker parameter in a subsequent pagination request.
7861 Marker *string `type:"string"`
8269 Marker *string `min:"1" type:"string"`
78628270
78638271 // A list of policy names.
78648272 PolicyNames []*string `type:"list" required:"true"`
78818289 }
78828290
78838291 type ListGroupsForUserInput struct {
7884 // Use this parameter only when paginating results and only after you have received
7885 // a response where the results are truncated. Set it to the value of the Marker
7886 // element in the response you just received.
7887 Marker *string `type:"string"`
8292 // Use this parameter only when paginating results and only after you receive
8293 // a response indicating that the results are truncated. Set it to the value
8294 // of the Marker element in the response you received to inform the next call
8295 // about where to start.
8296 Marker *string `min:"1" type:"string"`
78888297
78898298 // Use this only when paginating results to indicate the maximum number of items
78908299 // you want in the response. If there are additional items beyond the maximum
78918300 // you specify, the IsTruncated response element is true.
78928301 //
78938302 // This parameter is optional. If you do not include it, it defaults to 100.
7894 MaxItems *int64 `type:"integer"`
8303 // Note that IAM might return fewer results, even when there are more results
8304 // available. If this is the case, the IsTruncated response element returns
8305 // true and Marker contains a value to include in the subsequent call that tells
8306 // the service where to continue from.
8307 MaxItems *int64 `min:"1" type:"integer"`
78958308
78968309 // The name of the user to list groups for.
7897 UserName *string `type:"string" required:"true"`
8310 UserName *string `min:"1" type:"string" required:"true"`
78988311
78998312 metadataListGroupsForUserInput `json:"-" xml:"-"`
79008313 }
79208333
79218334 // A flag that indicates whether there are more items to return. If your results
79228335 // were truncated, you can make a subsequent pagination request using the Marker
7923 // request parameter to retrieve more items.
8336 // request parameter to retrieve more items. Note that IAM might return fewer
8337 // than the MaxItems number of results even when there are more results available.
8338 // We recommend that you check IsTruncated after every call to ensure that you
8339 // receive all of your results.
79248340 IsTruncated *bool `type:"boolean"`
79258341
79268342 // When IsTruncated is true, this element is present and contains the value
79278343 // to use for the Marker parameter in a subsequent pagination request.
7928 Marker *string `type:"string"`
8344 Marker *string `min:"1" type:"string"`
79298345
79308346 metadataListGroupsForUserOutput `json:"-" xml:"-"`
79318347 }
79458361 }
79468362
79478363 type ListGroupsInput struct {
7948 // Use this parameter only when paginating results and only after you have received
7949 // a response where the results are truncated. Set it to the value of the Marker
7950 // element in the response you just received.
7951 Marker *string `type:"string"`
8364 // Use this parameter only when paginating results and only after you receive
8365 // a response indicating that the results are truncated. Set it to the value
8366 // of the Marker element in the response you received to inform the next call
8367 // about where to start.
8368 Marker *string `min:"1" type:"string"`
79528369
79538370 // Use this only when paginating results to indicate the maximum number of items
79548371 // you want in the response. If there are additional items beyond the maximum
79558372 // you specify, the IsTruncated response element is true.
79568373 //
79578374 // This parameter is optional. If you do not include it, it defaults to 100.
7958 MaxItems *int64 `type:"integer"`
8375 // Note that IAM might return fewer results, even when there are more results
8376 // available. If this is the case, the IsTruncated response element returns
8377 // true and Marker contains a value to include in the subsequent call that tells
8378 // the service where to continue from.
8379 MaxItems *int64 `min:"1" type:"integer"`
79598380
79608381 // The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/
79618382 // gets all groups whose path starts with /division_abc/subdivision_xyz/.
79628383 //
79638384 // This parameter is optional. If it is not included, it defaults to a slash
79648385 // (/), listing all groups.
7965 PathPrefix *string `type:"string"`
8386 PathPrefix *string `min:"1" type:"string"`
79668387
79678388 metadataListGroupsInput `json:"-" xml:"-"`
79688389 }
79888409
79898410 // A flag that indicates whether there are more items to return. If your results
79908411 // were truncated, you can make a subsequent pagination request using the Marker
7991 // request parameter to retrieve more items.
8412 // request parameter to retrieve more items. Note that IAM might return fewer
8413 // than the MaxItems number of results even when there are more results available.
8414 // We recommend that you check IsTruncated after every call to ensure that you
8415 // receive all of your results.
79928416 IsTruncated *bool `type:"boolean"`
79938417
79948418 // When IsTruncated is true, this element is present and contains the value
79958419 // to use for the Marker parameter in a subsequent pagination request.
7996 Marker *string `type:"string"`
8420 Marker *string `min:"1" type:"string"`
79978421
79988422 metadataListGroupsOutput `json:"-" xml:"-"`
79998423 }
80138437 }
80148438
80158439 type ListInstanceProfilesForRoleInput struct {
8016 // Use this parameter only when paginating results and only after you have received
8017 // a response where the results are truncated. Set it to the value of the Marker
8018 // element in the response you just received.
8019 Marker *string `type:"string"`
8440 // Use this parameter only when paginating results and only after you receive
8441 // a response indicating that the results are truncated. Set it to the value
8442 // of the Marker element in the response you received to inform the next call
8443 // about where to start.
8444 Marker *string `min:"1" type:"string"`
80208445
80218446 // Use this only when paginating results to indicate the maximum number of items
80228447 // you want in the response. If there are additional items beyond the maximum
80238448 // you specify, the IsTruncated response element is true.
80248449 //
80258450 // This parameter is optional. If you do not include it, it defaults to 100.
8026 MaxItems *int64 `type:"integer"`
8451 // Note that IAM might return fewer results, even when there are more results
8452 // available. If this is the case, the IsTruncated response element returns
8453 // true and Marker contains a value to include in the subsequent call that tells
8454 // the service where to continue from.
8455 MaxItems *int64 `min:"1" type:"integer"`
80278456
80288457 // The name of the role to list instance profiles for.
8029 RoleName *string `type:"string" required:"true"`
8458 RoleName *string `min:"1" type:"string" required:"true"`
80308459
80318460 metadataListInstanceProfilesForRoleInput `json:"-" xml:"-"`
80328461 }
80528481
80538482 // A flag that indicates whether there are more items to return. If your results
80548483 // were truncated, you can make a subsequent pagination request using the Marker
8055 // request parameter to retrieve more items.
8484 // request parameter to retrieve more items. Note that IAM might return fewer
8485 // than the MaxItems number of results even when there are more results available.
8486 // We recommend that you check IsTruncated after every call to ensure that you
8487 // receive all of your results.
80568488 IsTruncated *bool `type:"boolean"`
80578489
80588490 // When IsTruncated is true, this element is present and contains the value
80598491 // to use for the Marker parameter in a subsequent pagination request.
8060 Marker *string `type:"string"`
8492 Marker *string `min:"1" type:"string"`
80618493
80628494 metadataListInstanceProfilesForRoleOutput `json:"-" xml:"-"`
80638495 }
80778509 }
80788510
80798511 type ListInstanceProfilesInput struct {
8080 // Use this parameter only when paginating results and only after you have received
8081 // a response where the results are truncated. Set it to the value of the Marker
8082 // element in the response you just received.
8083 Marker *string `type:"string"`
8512 // Use this parameter only when paginating results and only after you receive
8513 // a response indicating that the results are truncated. Set it to the value
8514 // of the Marker element in the response you received to inform the next call
8515 // about where to start.
8516 Marker *string `min:"1" type:"string"`
80848517
80858518 // Use this only when paginating results to indicate the maximum number of items
80868519 // you want in the response. If there are additional items beyond the maximum
80878520 // you specify, the IsTruncated response element is true.
80888521 //
80898522 // This parameter is optional. If you do not include it, it defaults to 100.
8090 MaxItems *int64 `type:"integer"`
8523 // Note that IAM might return fewer results, even when there are more results
8524 // available. If this is the case, the IsTruncated response element returns
8525 // true and Marker contains a value to include in the subsequent call that tells
8526 // the service where to continue from.
8527 MaxItems *int64 `min:"1" type:"integer"`
80918528
80928529 // The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/
80938530 // gets all instance profiles whose path starts with /application_abc/component_xyz/.
80948531 //
80958532 // This parameter is optional. If it is not included, it defaults to a slash
80968533 // (/), listing all instance profiles.
8097 PathPrefix *string `type:"string"`
8534 PathPrefix *string `min:"1" type:"string"`
80988535
80998536 metadataListInstanceProfilesInput `json:"-" xml:"-"`
81008537 }
81208557
81218558 // A flag that indicates whether there are more items to return. If your results
81228559 // were truncated, you can make a subsequent pagination request using the Marker
8123 // request parameter to retrieve more items.
8560 // request parameter to retrieve more items. Note that IAM might return fewer
8561 // than the MaxItems number of results even when there are more results available.
8562 // We recommend that you check IsTruncated after every call to ensure that you
8563 // receive all of your results.
81248564 IsTruncated *bool `type:"boolean"`
81258565
81268566 // When IsTruncated is true, this element is present and contains the value
81278567 // to use for the Marker parameter in a subsequent pagination request.
8128 Marker *string `type:"string"`
8568 Marker *string `min:"1" type:"string"`
81298569
81308570 metadataListInstanceProfilesOutput `json:"-" xml:"-"`
81318571 }
81458585 }
81468586
81478587 type ListMFADevicesInput struct {
8148 // Use this parameter only when paginating results and only after you have received
8149 // a response where the results are truncated. Set it to the value of the Marker
8150 // element in the response you just received.
8151 Marker *string `type:"string"`
8588 // Use this parameter only when paginating results and only after you receive
8589 // a response indicating that the results are truncated. Set it to the value
8590 // of the Marker element in the response you received to inform the next call
8591 // about where to start.
8592 Marker *string `min:"1" type:"string"`
81528593
81538594 // Use this only when paginating results to indicate the maximum number of items
81548595 // you want in the response. If there are additional items beyond the maximum
81558596 // you specify, the IsTruncated response element is true.
81568597 //
81578598 // This parameter is optional. If you do not include it, it defaults to 100.
8158 MaxItems *int64 `type:"integer"`
8599 // Note that IAM might return fewer results, even when there are more results
8600 // available. If this is the case, the IsTruncated response element returns
8601 // true and Marker contains a value to include in the subsequent call that tells
8602 // the service where to continue from.
8603 MaxItems *int64 `min:"1" type:"integer"`
81598604
81608605 // The name of the user whose MFA devices you want to list.
8161 UserName *string `type:"string"`
8606 UserName *string `min:"1" type:"string"`
81628607
81638608 metadataListMFADevicesInput `json:"-" xml:"-"`
81648609 }
81818626 type ListMFADevicesOutput struct {
81828627 // A flag that indicates whether there are more items to return. If your results
81838628 // were truncated, you can make a subsequent pagination request using the Marker
8184 // request parameter to retrieve more items.
8629 // request parameter to retrieve more items. Note that IAM might return fewer
8630 // than the MaxItems number of results even when there are more results available.
8631 // We recommend that you check IsTruncated after every call to ensure that you
8632 // receive all of your results.
81858633 IsTruncated *bool `type:"boolean"`
81868634
81878635 // A list of MFA devices.
81898637
81908638 // When IsTruncated is true, this element is present and contains the value
81918639 // to use for the Marker parameter in a subsequent pagination request.
8192 Marker *string `type:"string"`
8640 Marker *string `min:"1" type:"string"`
81938641
81948642 metadataListMFADevicesOutput `json:"-" xml:"-"`
81958643 }
82498697 }
82508698
82518699 type ListPoliciesInput struct {
8252 // Use this parameter only when paginating results and only after you have received
8253 // a response where the results are truncated. Set it to the value of the Marker
8254 // element in the response you just received.
8255 Marker *string `type:"string"`
8700 // Use this parameter only when paginating results and only after you receive
8701 // a response indicating that the results are truncated. Set it to the value
8702 // of the Marker element in the response you received to inform the next call
8703 // about where to start.
8704 Marker *string `min:"1" type:"string"`
82568705
82578706 // Use this only when paginating results to indicate the maximum number of items
82588707 // you want in the response. If there are additional items beyond the maximum
82598708 // you specify, the IsTruncated response element is true.
82608709 //
82618710 // This parameter is optional. If you do not include it, it defaults to 100.
8262 MaxItems *int64 `type:"integer"`
8711 // Note that IAM might return fewer results, even when there are more results
8712 // available. If this is the case, the IsTruncated response element returns
8713 // true and Marker contains a value to include in the subsequent call that tells
8714 // the service where to continue from.
8715 MaxItems *int64 `min:"1" type:"integer"`
82638716
82648717 // A flag to filter the results to only the attached policies.
82658718 //
83028755 type ListPoliciesOutput struct {
83038756 // A flag that indicates whether there are more items to return. If your results
83048757 // were truncated, you can make a subsequent pagination request using the Marker
8305 // request parameter to retrieve more items.
8758 // request parameter to retrieve more items. Note that IAM might return fewer
8759 // than the MaxItems number of results even when there are more results available.
8760 // We recommend that you check IsTruncated after every call to ensure that you
8761 // receive all of your results.
83068762 IsTruncated *bool `type:"boolean"`
83078763
83088764 // When IsTruncated is true, this element is present and contains the value
83098765 // to use for the Marker parameter in a subsequent pagination request.
8310 Marker *string `type:"string"`
8766 Marker *string `min:"1" type:"string"`
83118767
83128768 // A list of policies.
83138769 Policies []*Policy `type:"list"`
83308786 }
83318787
83328788 type ListPolicyVersionsInput struct {
8333 // Use this parameter only when paginating results and only after you have received
8334 // a response where the results are truncated. Set it to the value of the Marker
8335 // element in the response you just received.
8336 Marker *string `type:"string"`
8789 // Use this parameter only when paginating results and only after you receive
8790 // a response indicating that the results are truncated. Set it to the value
8791 // of the Marker element in the response you received to inform the next call
8792 // about where to start.
8793 Marker *string `min:"1" type:"string"`
83378794
83388795 // Use this only when paginating results to indicate the maximum number of items
83398796 // you want in the response. If there are additional items beyond the maximum
83408797 // you specify, the IsTruncated response element is true.
83418798 //
83428799 // This parameter is optional. If you do not include it, it defaults to 100.
8343 MaxItems *int64 `type:"integer"`
8800 // Note that IAM might return fewer results, even when there are more results
8801 // available. If this is the case, the IsTruncated response element returns
8802 // true and Marker contains a value to include in the subsequent call that tells
8803 // the service where to continue from.
8804 MaxItems *int64 `min:"1" type:"integer"`
83448805
83458806 // The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.
83468807 //
83478808 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
83488809 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
83498810 // in the AWS General Reference.
8350 PolicyArn *string `type:"string" required:"true"`
8811 PolicyArn *string `min:"20" type:"string" required:"true"`
83518812
83528813 metadataListPolicyVersionsInput `json:"-" xml:"-"`
83538814 }
83708831 type ListPolicyVersionsOutput struct {
83718832 // A flag that indicates whether there are more items to return. If your results
83728833 // were truncated, you can make a subsequent pagination request using the Marker
8373 // request parameter to retrieve more items.
8834 // request parameter to retrieve more items. Note that IAM might return fewer
8835 // than the MaxItems number of results even when there are more results available.
8836 // We recommend that you check IsTruncated after every call to ensure that you
8837 // receive all of your results.
83748838 IsTruncated *bool `type:"boolean"`
83758839
83768840 // When IsTruncated is true, this element is present and contains the value
83778841 // to use for the Marker parameter in a subsequent pagination request.
8378 Marker *string `type:"string"`
8842 Marker *string `min:"1" type:"string"`
83798843
83808844 // A list of policy versions.
83818845 //
83828846 // For more information about managed policy versions, see Versioning for Managed
83838847 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
8384 // in the Using IAM guide.
8848 // in the IAM User Guide.
83858849 Versions []*PolicyVersion `type:"list"`
83868850
83878851 metadataListPolicyVersionsOutput `json:"-" xml:"-"`
84028866 }
84038867
84048868 type ListRolePoliciesInput struct {
8405 // Use this parameter only when paginating results and only after you have received
8406 // a response where the results are truncated. Set it to the value of the Marker
8407 // element in the response you just received.
8408 Marker *string `type:"string"`
8869 // Use this parameter only when paginating results and only after you receive
8870 // a response indicating that the results are truncated. Set it to the value
8871 // of the Marker element in the response you received to inform the next call
8872 // about where to start.
8873 Marker *string `min:"1" type:"string"`
84098874
84108875 // Use this only when paginating results to indicate the maximum number of items
84118876 // you want in the response. If there are additional items beyond the maximum
84128877 // you specify, the IsTruncated response element is true.
84138878 //
84148879 // This parameter is optional. If you do not include it, it defaults to 100.
8415 MaxItems *int64 `type:"integer"`
8880 // Note that IAM might return fewer results, even when there are more results
8881 // available. If this is the case, the IsTruncated response element returns
8882 // true and Marker contains a value to include in the subsequent call that tells
8883 // the service where to continue from.
8884 MaxItems *int64 `min:"1" type:"integer"`
84168885
84178886 // The name of the role to list policies for.
8418 RoleName *string `type:"string" required:"true"`
8887 RoleName *string `min:"1" type:"string" required:"true"`
84198888
84208889 metadataListRolePoliciesInput `json:"-" xml:"-"`
84218890 }
84388907 type ListRolePoliciesOutput struct {
84398908 // A flag that indicates whether there are more items to return. If your results
84408909 // were truncated, you can make a subsequent pagination request using the Marker
8441 // request parameter to retrieve more items.
8910 // request parameter to retrieve more items. Note that IAM might return fewer
8911 // than the MaxItems number of results even when there are more results available.
8912 // We recommend that you check IsTruncated after every call to ensure that you
8913 // receive all of your results.
84428914 IsTruncated *bool `type:"boolean"`
84438915
84448916 // When IsTruncated is true, this element is present and contains the value
84458917 // to use for the Marker parameter in a subsequent pagination request.
8446 Marker *string `type:"string"`
8918 Marker *string `min:"1" type:"string"`
84478919
84488920 // A list of policy names.
84498921 PolicyNames []*string `type:"list" required:"true"`
84668938 }
84678939
84688940 type ListRolesInput struct {
8469 // Use this parameter only when paginating results and only after you have received
8470 // a response where the results are truncated. Set it to the value of the Marker
8471 // element in the response you just received.
8472 Marker *string `type:"string"`
8941 // Use this parameter only when paginating results and only after you receive
8942 // a response indicating that the results are truncated. Set it to the value
8943 // of the Marker element in the response you received to inform the next call
8944 // about where to start.
8945 Marker *string `min:"1" type:"string"`
84738946
84748947 // Use this only when paginating results to indicate the maximum number of items
84758948 // you want in the response. If there are additional items beyond the maximum
84768949 // you specify, the IsTruncated response element is true.
84778950 //
84788951 // This parameter is optional. If you do not include it, it defaults to 100.
8479 MaxItems *int64 `type:"integer"`
8952 // Note that IAM might return fewer results, even when there are more results
8953 // available. If this is the case, the IsTruncated response element returns
8954 // true and Marker contains a value to include in the subsequent call that tells
8955 // the service where to continue from.
8956 MaxItems *int64 `min:"1" type:"integer"`
84808957
84818958 // The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/
84828959 // gets all roles whose path starts with /application_abc/component_xyz/.
84838960 //
84848961 // This parameter is optional. If it is not included, it defaults to a slash
84858962 // (/), listing all roles.
8486 PathPrefix *string `type:"string"`
8963 PathPrefix *string `min:"1" type:"string"`
84878964
84888965 metadataListRolesInput `json:"-" xml:"-"`
84898966 }
85068983 type ListRolesOutput struct {
85078984 // A flag that indicates whether there are more items to return. If your results
85088985 // were truncated, you can make a subsequent pagination request using the Marker
8509 // request parameter to retrieve more items.
8986 // request parameter to retrieve more items. Note that IAM might return fewer
8987 // than the MaxItems number of results even when there are more results available.
8988 // We recommend that you check IsTruncated after every call to ensure that you
8989 // receive all of your results.
85108990 IsTruncated *bool `type:"boolean"`
85118991
85128992 // When IsTruncated is true, this element is present and contains the value
85138993 // to use for the Marker parameter in a subsequent pagination request.
8514 Marker *string `type:"string"`
8994 Marker *string `min:"1" type:"string"`
85158995
85168996 // A list of roles.
85178997 Roles []*Role `type:"list" required:"true"`
85749054 }
85759055
85769056 type ListSSHPublicKeysInput struct {
8577 // Use this parameter only when paginating results and only after you have received
8578 // a response where the results are truncated. Set it to the value of the Marker
8579 // element in the response you just received.
8580 Marker *string `type:"string"`
9057 // Use this parameter only when paginating results and only after you receive
9058 // a response indicating that the results are truncated. Set it to the value
9059 // of the Marker element in the response you received to inform the next call
9060 // about where to start.
9061 Marker *string `min:"1" type:"string"`
85819062
85829063 // Use this only when paginating results to indicate the maximum number of items
85839064 // you want in the response. If there are additional items beyond the maximum
85849065 // you specify, the IsTruncated response element is true.
85859066 //
85869067 // This parameter is optional. If you do not include it, it defaults to 100.
8587 MaxItems *int64 `type:"integer"`
9068 // Note that IAM might return fewer results, even when there are more results
9069 // available. If this is the case, the IsTruncated response element returns
9070 // true and Marker contains a value to include in the subsequent call that tells
9071 // the service where to continue from.
9072 MaxItems *int64 `min:"1" type:"integer"`
85889073
85899074 // The name of the IAM user to list SSH public keys for. If none is specified,
85909075 // the UserName field is determined implicitly based on the AWS access key used
85919076 // to sign the request.
8592 UserName *string `type:"string"`
9077 UserName *string `min:"1" type:"string"`
85939078
85949079 metadataListSSHPublicKeysInput `json:"-" xml:"-"`
85959080 }
86129097 type ListSSHPublicKeysOutput struct {
86139098 // A flag that indicates whether there are more items to return. If your results
86149099 // were truncated, you can make a subsequent pagination request using the Marker
8615 // request parameter to retrieve more items.
9100 // request parameter to retrieve more items. Note that IAM might return fewer
9101 // than the MaxItems number of results even when there are more results available.
9102 // We recommend that you check IsTruncated after every call to ensure that you
9103 // receive all of your results.
86169104 IsTruncated *bool `type:"boolean"`
86179105
86189106 // When IsTruncated is true, this element is present and contains the value
86199107 // to use for the Marker parameter in a subsequent pagination request.
8620 Marker *string `type:"string"`
9108 Marker *string `min:"1" type:"string"`
86219109
86229110 // A list of SSH public keys.
86239111 SSHPublicKeys []*SSHPublicKeyMetadata `type:"list"`
86409128 }
86419129
86429130 type ListServerCertificatesInput struct {
8643 // Use this parameter only when paginating results and only after you have received
8644 // a response where the results are truncated. Set it to the value of the Marker
8645 // element in the response you just received.
8646 Marker *string `type:"string"`
9131 // Use this parameter only when paginating results and only after you receive
9132 // a response indicating that the results are truncated. Set it to the value
9133 // of the Marker element in the response you received to inform the next call
9134 // about where to start.
9135 Marker *string `min:"1" type:"string"`
86479136
86489137 // Use this only when paginating results to indicate the maximum number of items
86499138 // you want in the response. If there are additional items beyond the maximum
86509139 // you specify, the IsTruncated response element is true.
86519140 //
86529141 // This parameter is optional. If you do not include it, it defaults to 100.
8653 MaxItems *int64 `type:"integer"`
9142 // Note that IAM might return fewer results, even when there are more results
9143 // available. If this is the case, the IsTruncated response element returns
9144 // true and Marker contains a value to include in the subsequent call that tells
9145 // the service where to continue from.
9146 MaxItems *int64 `min:"1" type:"integer"`
86549147
86559148 // The path prefix for filtering the results. For example: /company/servercerts
86569149 // would get all server certificates for which the path starts with /company/servercerts.
86579150 //
86589151 // This parameter is optional. If it is not included, it defaults to a slash
86599152 // (/), listing all server certificates.
8660 PathPrefix *string `type:"string"`
9153 PathPrefix *string `min:"1" type:"string"`
86619154
86629155 metadataListServerCertificatesInput `json:"-" xml:"-"`
86639156 }
86809173 type ListServerCertificatesOutput struct {
86819174 // A flag that indicates whether there are more items to return. If your results
86829175 // were truncated, you can make a subsequent pagination request using the Marker
8683 // request parameter to retrieve more items.
9176 // request parameter to retrieve more items. Note that IAM might return fewer
9177 // than the MaxItems number of results even when there are more results available.
9178 // We recommend that you check IsTruncated after every call to ensure that you
9179 // receive all of your results.
86849180 IsTruncated *bool `type:"boolean"`
86859181
86869182 // When IsTruncated is true, this element is present and contains the value
86879183 // to use for the Marker parameter in a subsequent pagination request.
8688 Marker *string `type:"string"`
9184 Marker *string `min:"1" type:"string"`
86899185
86909186 // A list of server certificates.
86919187 ServerCertificateMetadataList []*ServerCertificateMetadata `type:"list" required:"true"`
87089204 }
87099205
87109206 type ListSigningCertificatesInput struct {
8711 // Use this parameter only when paginating results and only after you have received
8712 // a response where the results are truncated. Set it to the value of the Marker
8713 // element in the response you just received.
8714 Marker *string `type:"string"`
9207 // Use this parameter only when paginating results and only after you receive
9208 // a response indicating that the results are truncated. Set it to the value
9209 // of the Marker element in the response you received to inform the next call
9210 // about where to start.
9211 Marker *string `min:"1" type:"string"`
87159212
87169213 // Use this only when paginating results to indicate the maximum number of items
87179214 // you want in the response. If there are additional items beyond the maximum
87189215 // you specify, the IsTruncated response element is true.
87199216 //
87209217 // This parameter is optional. If you do not include it, it defaults to 100.
8721 MaxItems *int64 `type:"integer"`
9218 // Note that IAM might return fewer results, even when there are more results
9219 // available. If this is the case, the IsTruncated response element returns
9220 // true and Marker contains a value to include in the subsequent call that tells
9221 // the service where to continue from.
9222 MaxItems *int64 `min:"1" type:"integer"`
87229223
87239224 // The name of the user.
8724 UserName *string `type:"string"`
9225 UserName *string `min:"1" type:"string"`
87259226
87269227 metadataListSigningCertificatesInput `json:"-" xml:"-"`
87279228 }
87479248
87489249 // A flag that indicates whether there are more items to return. If your results
87499250 // were truncated, you can make a subsequent pagination request using the Marker
8750 // request parameter to retrieve more items.
9251 // request parameter to retrieve more items. Note that IAM might return fewer
9252 // than the MaxItems number of results even when there are more results available.
9253 // We recommend that you check IsTruncated after every call to ensure that you
9254 // receive all of your results.
87519255 IsTruncated *bool `type:"boolean"`
87529256
87539257 // When IsTruncated is true, this element is present and contains the value
87549258 // to use for the Marker parameter in a subsequent pagination request.
8755 Marker *string `type:"string"`
9259 Marker *string `min:"1" type:"string"`
87569260
87579261 metadataListSigningCertificatesOutput `json:"-" xml:"-"`
87589262 }
87729276 }
87739277
87749278 type ListUserPoliciesInput struct {
8775 // Use this parameter only when paginating results and only after you have received
8776 // a response where the results are truncated. Set it to the value of the Marker
8777 // element in the response you just received.
8778 Marker *string `type:"string"`
9279 // Use this parameter only when paginating results and only after you receive
9280 // a response indicating that the results are truncated. Set it to the value
9281 // of the Marker element in the response you received to inform the next call
9282 // about where to start.
9283 Marker *string `min:"1" type:"string"`
87799284
87809285 // Use this only when paginating results to indicate the maximum number of items
87819286 // you want in the response. If there are additional items beyond the maximum
87829287 // you specify, the IsTruncated response element is true.
87839288 //
87849289 // This parameter is optional. If you do not include it, it defaults to 100.
8785 MaxItems *int64 `type:"integer"`
9290 // Note that IAM might return fewer results, even when there are more results
9291 // available. If this is the case, the IsTruncated response element returns
9292 // true and Marker contains a value to include in the subsequent call that tells
9293 // the service where to continue from.
9294 MaxItems *int64 `min:"1" type:"integer"`
87869295
87879296 // The name of the user to list policies for.
8788 UserName *string `type:"string" required:"true"`
9297 UserName *string `min:"1" type:"string" required:"true"`
87899298
87909299 metadataListUserPoliciesInput `json:"-" xml:"-"`
87919300 }
88089317 type ListUserPoliciesOutput struct {
88099318 // A flag that indicates whether there are more items to return. If your results
88109319 // were truncated, you can make a subsequent pagination request using the Marker
8811 // request parameter to retrieve more items.
9320 // request parameter to retrieve more items. Note that IAM might return fewer
9321 // than the MaxItems number of results even when there are more results available.
9322 // We recommend that you check IsTruncated after every call to ensure that you
9323 // receive all of your results.
88129324 IsTruncated *bool `type:"boolean"`
88139325
88149326 // When IsTruncated is true, this element is present and contains the value
88159327 // to use for the Marker parameter in a subsequent pagination request.
8816 Marker *string `type:"string"`
9328 Marker *string `min:"1" type:"string"`
88179329
88189330 // A list of policy names.
88199331 PolicyNames []*string `type:"list" required:"true"`
88369348 }
88379349
88389350 type ListUsersInput struct {
8839 // Use this parameter only when paginating results and only after you have received
8840 // a response where the results are truncated. Set it to the value of the Marker
8841 // element in the response you just received.
8842 Marker *string `type:"string"`
9351 // Use this parameter only when paginating results and only after you receive
9352 // a response indicating that the results are truncated. Set it to the value
9353 // of the Marker element in the response you received to inform the next call
9354 // about where to start.
9355 Marker *string `min:"1" type:"string"`
88439356
88449357 // Use this only when paginating results to indicate the maximum number of items
88459358 // you want in the response. If there are additional items beyond the maximum
88469359 // you specify, the IsTruncated response element is true.
88479360 //
88489361 // This parameter is optional. If you do not include it, it defaults to 100.
8849 MaxItems *int64 `type:"integer"`
9362 // Note that IAM might return fewer results, even when there are more results
9363 // available. If this is the case, the IsTruncated response element returns
9364 // true and Marker contains a value to include in the subsequent call that tells
9365 // the service where to continue from.
9366 MaxItems *int64 `min:"1" type:"integer"`
88509367
88519368 // The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/,
88529369 // which would get all user names whose path starts with /division_abc/subdivision_xyz/.
88539370 //
88549371 // This parameter is optional. If it is not included, it defaults to a slash
88559372 // (/), listing all user names.
8856 PathPrefix *string `type:"string"`
9373 PathPrefix *string `min:"1" type:"string"`
88579374
88589375 metadataListUsersInput `json:"-" xml:"-"`
88599376 }
88769393 type ListUsersOutput struct {
88779394 // A flag that indicates whether there are more items to return. If your results
88789395 // were truncated, you can make a subsequent pagination request using the Marker
8879 // request parameter to retrieve more items.
9396 // request parameter to retrieve more items. Note that IAM might return fewer
9397 // than the MaxItems number of results even when there are more results available.
9398 // We recommend that you check IsTruncated after every call to ensure that you
9399 // receive all of your results.
88809400 IsTruncated *bool `type:"boolean"`
88819401
88829402 // When IsTruncated is true, this element is present and contains the value
88839403 // to use for the Marker parameter in a subsequent pagination request.
8884 Marker *string `type:"string"`
9404 Marker *string `min:"1" type:"string"`
88859405
88869406 // A list of users.
88879407 Users []*User `type:"list" required:"true"`
89099429 // assigned and unassigned virtual MFA devices.
89109430 AssignmentStatus *string `type:"string" enum:"assignmentStatusType"`
89119431
8912 // Use this parameter only when paginating results and only after you have received
8913 // a response where the results are truncated. Set it to the value of the Marker
8914 // element in the response you just received.
8915 Marker *string `type:"string"`
9432 // Use this parameter only when paginating results and only after you receive
9433 // a response indicating that the results are truncated. Set it to the value
9434 // of the Marker element in the response you received to inform the next call
9435 // about where to start.
9436 Marker *string `min:"1" type:"string"`
89169437
89179438 // Use this only when paginating results to indicate the maximum number of items
89189439 // you want in the response. If there are additional items beyond the maximum
89199440 // you specify, the IsTruncated response element is true.
89209441 //
89219442 // This parameter is optional. If you do not include it, it defaults to 100.
8922 MaxItems *int64 `type:"integer"`
9443 // Note that IAM might return fewer results, even when there are more results
9444 // available. If this is the case, the IsTruncated response element returns
9445 // true and Marker contains a value to include in the subsequent call that tells
9446 // the service where to continue from.
9447 MaxItems *int64 `min:"1" type:"integer"`
89239448
89249449 metadataListVirtualMFADevicesInput `json:"-" xml:"-"`
89259450 }
89429467 type ListVirtualMFADevicesOutput struct {
89439468 // A flag that indicates whether there are more items to return. If your results
89449469 // were truncated, you can make a subsequent pagination request using the Marker
8945 // request parameter to retrieve more items.
9470 // request parameter to retrieve more items. Note that IAM might return fewer
9471 // than the MaxItems number of results even when there are more results available.
9472 // We recommend that you check IsTruncated after every call to ensure that you
9473 // receive all of your results.
89469474 IsTruncated *bool `type:"boolean"`
89479475
89489476 // When IsTruncated is true, this element is present and contains the value
89499477 // to use for the Marker parameter in a subsequent pagination request.
8950 Marker *string `type:"string"`
9478 Marker *string `min:"1" type:"string"`
89519479
89529480 // The list of virtual MFA devices in the current account that match the AssignmentStatus
89539481 // value that was passed in the request.
89839511
89849512 // The name of the user, which can be used for signing in to the AWS Management
89859513 // Console.
8986 UserName *string `type:"string" required:"true"`
9514 UserName *string `min:"1" type:"string" required:"true"`
89879515
89889516 metadataLoginProfile `json:"-" xml:"-"`
89899517 }
90119539
90129540 // The serial number that uniquely identifies the MFA device. For virtual MFA
90139541 // devices, the serial number is the device ARN.
9014 SerialNumber *string `type:"string" required:"true"`
9542 SerialNumber *string `min:"9" type:"string" required:"true"`
90159543
90169544 // The user with whom the MFA device is associated.
9017 UserName *string `type:"string" required:"true"`
9545 UserName *string `min:"1" type:"string" required:"true"`
90189546
90199547 metadataMFADevice `json:"-" xml:"-"`
90209548 }
90499577 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
90509578 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
90519579 // in the AWS General Reference.
9052 Arn *string `type:"string"`
9580 Arn *string `min:"20" type:"string"`
90539581
90549582 // The number of principal entities (users, groups, and roles) that the policy
90559583 // is attached to.
90839611 //
90849612 // For more information about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
90859613 // in the Using IAM guide.
9086 PolicyId *string `type:"string"`
9614 PolicyId *string `min:"16" type:"string"`
90879615
90889616 // The friendly name (not ARN) identifying the policy.
9089 PolicyName *string `type:"string"`
9617 PolicyName *string `min:"1" type:"string"`
90909618
90919619 // A list containing information about the versions of the policy.
90929620 PolicyVersionList []*PolicyVersion `type:"list"`
91249652 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
91259653 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
91269654 // in the AWS General Reference.
9127 Arn *string `type:"string"`
9655 Arn *string `min:"20" type:"string"`
91289656
91299657 metadataOpenIDConnectProviderListEntry `json:"-" xml:"-"`
91309658 }
91609688 HardExpiry *bool `type:"boolean"`
91619689
91629690 // The number of days that an IAM user password is valid.
9163 MaxPasswordAge *int64 `type:"integer"`
9691 MaxPasswordAge *int64 `min:"1" type:"integer"`
91649692
91659693 // Minimum length to require for IAM user passwords.
9166 MinimumPasswordLength *int64 `type:"integer"`
9694 MinimumPasswordLength *int64 `min:"6" type:"integer"`
91679695
91689696 // Specifies the number of previous passwords that IAM users are prevented from
91699697 // reusing.
9170 PasswordReusePrevention *int64 `type:"integer"`
9698 PasswordReusePrevention *int64 `min:"1" type:"integer"`
91719699
91729700 // Specifies whether to require lowercase characters for IAM user passwords.
91739701 RequireLowercaseCharacters *bool `type:"boolean"`
92129740 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
92139741 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
92149742 // in the AWS General Reference.
9215 Arn *string `type:"string"`
9743 Arn *string `min:"20" type:"string"`
92169744
92179745 // The number of entities (users, groups, and roles) that the policy is attached
92189746 // to.
92449772 //
92459773 // For more information about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
92469774 // in the Using IAM guide.
9247 PolicyId *string `type:"string"`
9775 PolicyId *string `min:"16" type:"string"`
92489776
92499777 // The friendly name (not ARN) identifying the policy.
9250 PolicyName *string `type:"string"`
9778 PolicyName *string `min:"1" type:"string"`
92519779
92529780 // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),
92539781 // when the policy was last updated.
92819809 // action.
92829810 type PolicyDetail struct {
92839811 // The policy document.
9284 PolicyDocument *string `type:"string"`
9812 PolicyDocument *string `min:"1" type:"string"`
92859813
92869814 // The name of the policy.
9287 PolicyName *string `type:"string"`
9815 PolicyName *string `min:"1" type:"string"`
92889816
92899817 metadataPolicyDetail `json:"-" xml:"-"`
92909818 }
93139841 // in the Using IAM guide.
93149842 type PolicyGroup struct {
93159843 // The name (friendly name, not ARN) identifying the group.
9316 GroupName *string `type:"string"`
9844 GroupName *string `min:"1" type:"string"`
93179845
93189846 metadataPolicyGroup `json:"-" xml:"-"`
93199847 }
93429870 // in the Using IAM guide.
93439871 type PolicyRole struct {
93449872 // The name (friendly name, not ARN) identifying the role.
9345 RoleName *string `type:"string"`
9873 RoleName *string `min:"1" type:"string"`
93469874
93479875 metadataPolicyRole `json:"-" xml:"-"`
93489876 }
93719899 // in the Using IAM guide.
93729900 type PolicyUser struct {
93739901 // The name (friendly name, not ARN) identifying the user.
9374 UserName *string `type:"string"`
9902 UserName *string `min:"1" type:"string"`
93759903
93769904 metadataPolicyUser `json:"-" xml:"-"`
93779905 }
94099937 // The policy document is returned in the response to the GetPolicyVersion
94109938 // and GetAccountAuthorizationDetails operations. It is not returned in the
94119939 // response to the CreatePolicyVersion or ListPolicyVersions operations.
9412 Document *string `type:"string"`
9940 Document *string `min:"1" type:"string"`
94139941
94149942 // Specifies whether the policy version is set as the policy's default version.
94159943 IsDefaultVersion *bool `type:"boolean"`
94379965 return s.String()
94389966 }
94399967
9968 // Contains the row and column of a location of a Statement element in a policy
9969 // document.
9970 //
9971 // This data type is used as a member of the Statement type.
9972 type Position struct {
9973 // The column in the line containing the specified position in the document.
9974 Column *int64 `type:"integer"`
9975
9976 // The line containing the specified position in the document.
9977 Line *int64 `type:"integer"`
9978
9979 metadataPosition `json:"-" xml:"-"`
9980 }
9981
9982 type metadataPosition struct {
9983 SDKShapeTraits bool `type:"structure"`
9984 }
9985
9986 // String returns the string representation
9987 func (s Position) String() string {
9988 return awsutil.Prettify(s)
9989 }
9990
9991 // GoString returns the string representation
9992 func (s Position) GoString() string {
9993 return s.String()
9994 }
9995
94409996 type PutGroupPolicyInput struct {
94419997 // The name of the group to associate the policy with.
9442 GroupName *string `type:"string" required:"true"`
9998 GroupName *string `min:"1" type:"string" required:"true"`
94439999
944410000 // The policy document.
9445 PolicyDocument *string `type:"string" required:"true"`
10001 PolicyDocument *string `min:"1" type:"string" required:"true"`
944610002
944710003 // The name of the policy document.
9448 PolicyName *string `type:"string" required:"true"`
10004 PolicyName *string `min:"1" type:"string" required:"true"`
944910005
945010006 metadataPutGroupPolicyInput `json:"-" xml:"-"`
945110007 }
948410040
948510041 type PutRolePolicyInput struct {
948610042 // The policy document.
9487 PolicyDocument *string `type:"string" required:"true"`
10043 PolicyDocument *string `min:"1" type:"string" required:"true"`
948810044
948910045 // The name of the policy document.
9490 PolicyName *string `type:"string" required:"true"`
10046 PolicyName *string `min:"1" type:"string" required:"true"`
949110047
949210048 // The name of the role to associate the policy with.
9493 RoleName *string `type:"string" required:"true"`
10049 RoleName *string `min:"1" type:"string" required:"true"`
949410050
949510051 metadataPutRolePolicyInput `json:"-" xml:"-"`
949610052 }
952910085
953010086 type PutUserPolicyInput struct {
953110087 // The policy document.
9532 PolicyDocument *string `type:"string" required:"true"`
10088 PolicyDocument *string `min:"1" type:"string" required:"true"`
953310089
953410090 // The name of the policy document.
9535 PolicyName *string `type:"string" required:"true"`
10091 PolicyName *string `min:"1" type:"string" required:"true"`
953610092
953710093 // The name of the user to associate the policy with.
9538 UserName *string `type:"string" required:"true"`
10094 UserName *string `min:"1" type:"string" required:"true"`
953910095
954010096 metadataPutUserPolicyInput `json:"-" xml:"-"`
954110097 }
957510131 type RemoveClientIDFromOpenIDConnectProviderInput struct {
957610132 // The client ID (also known as audience) to remove from the IAM OpenID Connect
957710133 // provider. For more information about client IDs, see CreateOpenIDConnectProvider.
9578 ClientID *string `type:"string" required:"true"`
10134 ClientID *string `min:"1" type:"string" required:"true"`
957910135
958010136 // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider
958110137 // to remove the client ID from. You can get a list of OIDC provider ARNs by
958210138 // using the ListOpenIDConnectProviders action.
9583 OpenIDConnectProviderArn *string `type:"string" required:"true"`
10139 OpenIDConnectProviderArn *string `min:"20" type:"string" required:"true"`
958410140
958510141 metadataRemoveClientIDFromOpenIDConnectProviderInput `json:"-" xml:"-"`
958610142 }
961910175
962010176 type RemoveRoleFromInstanceProfileInput struct {
962110177 // The name of the instance profile to update.
9622 InstanceProfileName *string `type:"string" required:"true"`
10178 InstanceProfileName *string `min:"1" type:"string" required:"true"`
962310179
962410180 // The name of the role to remove.
9625 RoleName *string `type:"string" required:"true"`
10181 RoleName *string `min:"1" type:"string" required:"true"`
962610182
962710183 metadataRemoveRoleFromInstanceProfileInput `json:"-" xml:"-"`
962810184 }
966110217
966210218 type RemoveUserFromGroupInput struct {
966310219 // The name of the group to update.
9664 GroupName *string `type:"string" required:"true"`
10220 GroupName *string `min:"1" type:"string" required:"true"`
966510221
966610222 // The name of the user to remove.
9667 UserName *string `type:"string" required:"true"`
10223 UserName *string `min:"1" type:"string" required:"true"`
966810224
966910225 metadataRemoveUserFromGroupInput `json:"-" xml:"-"`
967010226 }
970310259
970410260 type ResyncMFADeviceInput struct {
970510261 // An authentication code emitted by the device.
9706 AuthenticationCode1 *string `type:"string" required:"true"`
10262 AuthenticationCode1 *string `min:"6" type:"string" required:"true"`
970710263
970810264 // A subsequent authentication code emitted by the device.
9709 AuthenticationCode2 *string `type:"string" required:"true"`
10265 AuthenticationCode2 *string `min:"6" type:"string" required:"true"`
971010266
971110267 // Serial number that uniquely identifies the MFA device.
9712 SerialNumber *string `type:"string" required:"true"`
10268 SerialNumber *string `min:"9" type:"string" required:"true"`
971310269
971410270 // The name of the user whose MFA device you want to resynchronize.
9715 UserName *string `type:"string" required:"true"`
10271 UserName *string `min:"1" type:"string" required:"true"`
971610272
971710273 metadataResyncMFADeviceInput `json:"-" xml:"-"`
971810274 }
976210318 // The Amazon Resource Name (ARN) specifying the role. For more information
976310319 // about ARNs and how to use them in policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
976410320 // in the Using IAM guide.
9765 Arn *string `type:"string" required:"true"`
10321 Arn *string `min:"20" type:"string" required:"true"`
976610322
976710323 // The policy that grants an entity permission to assume the role.
9768 AssumeRolePolicyDocument *string `type:"string"`
10324 AssumeRolePolicyDocument *string `min:"1" type:"string"`
976910325
977010326 // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),
977110327 // when the role was created.
977410330 // The path to the role. For more information about paths, see IAM Identifiers
977510331 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
977610332 // in the Using IAM guide.
9777 Path *string `type:"string" required:"true"`
10333 Path *string `min:"1" type:"string" required:"true"`
977810334
977910335 // The stable and unique string identifying the role. For more information about
978010336 // IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
978110337 // in the Using IAM guide.
9782 RoleId *string `type:"string" required:"true"`
10338 RoleId *string `min:"16" type:"string" required:"true"`
978310339
978410340 // The friendly name that identifies the role.
9785 RoleName *string `type:"string" required:"true"`
10341 RoleName *string `min:"1" type:"string" required:"true"`
978610342
978710343 metadataRole `json:"-" xml:"-"`
978810344 }
981110367 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
981210368 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
981310369 // in the AWS General Reference.
9814 Arn *string `type:"string"`
10370 Arn *string `min:"20" type:"string"`
981510371
981610372 // The trust policy that grants permission to assume the role.
9817 AssumeRolePolicyDocument *string `type:"string"`
10373 AssumeRolePolicyDocument *string `min:"1" type:"string"`
981810374
981910375 // A list of managed policies attached to the role. These policies are the role's
982010376 // access (permissions) policies.
983010386 // The path to the role. For more information about paths, see IAM Identifiers
983110387 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
983210388 // in the Using IAM guide.
9833 Path *string `type:"string"`
10389 Path *string `min:"1" type:"string"`
983410390
983510391 // The stable and unique string identifying the role. For more information about
983610392 // IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
983710393 // in the Using IAM guide.
9838 RoleId *string `type:"string"`
10394 RoleId *string `min:"16" type:"string"`
983910395
984010396 // The friendly name that identifies the role.
9841 RoleName *string `type:"string"`
10397 RoleName *string `min:"1" type:"string"`
984210398
984310399 // A list of inline policies embedded in the role. These policies are the role's
984410400 // access (permissions) policies.
986410420 // Contains the list of SAML providers for this account.
986510421 type SAMLProviderListEntry struct {
986610422 // The Amazon Resource Name (ARN) of the SAML provider.
9867 Arn *string `type:"string"`
10423 Arn *string `min:"20" type:"string"`
986810424
986910425 // The date and time when the SAML provider was created.
987010426 CreateDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
989510451 // UploadSSHPublicKey actions.
989610452 type SSHPublicKey struct {
989710453 // The MD5 message digest of the SSH public key.
9898 Fingerprint *string `type:"string" required:"true"`
10454 Fingerprint *string `min:"48" type:"string" required:"true"`
989910455
990010456 // The SSH public key.
9901 SSHPublicKeyBody *string `type:"string" required:"true"`
10457 SSHPublicKeyBody *string `min:"1" type:"string" required:"true"`
990210458
990310459 // The unique identifier for the SSH public key.
9904 SSHPublicKeyId *string `type:"string" required:"true"`
10460 SSHPublicKeyId *string `min:"20" type:"string" required:"true"`
990510461
990610462 // The status of the SSH public key. Active means the key can be used for authentication
990710463 // with an AWS CodeCommit repository. Inactive means the key cannot be used.
991210468 UploadDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
991310469
991410470 // The name of the IAM user associated with the SSH public key.
9915 UserName *string `type:"string" required:"true"`
10471 UserName *string `min:"1" type:"string" required:"true"`
991610472
991710473 metadataSSHPublicKey `json:"-" xml:"-"`
991810474 }
993610492 // This data type is used as a response element in the ListSSHPublicKeys action.
993710493 type SSHPublicKeyMetadata struct {
993810494 // The unique identifier for the SSH public key.
9939 SSHPublicKeyId *string `type:"string" required:"true"`
10495 SSHPublicKeyId *string `min:"20" type:"string" required:"true"`
994010496
994110497 // The status of the SSH public key. Active means the key can be used for authentication
994210498 // with an AWS CodeCommit repository. Inactive means the key cannot be used.
994710503 UploadDate *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
994810504
994910505 // The name of the IAM user associated with the SSH public key.
9950 UserName *string `type:"string" required:"true"`
10506 UserName *string `min:"1" type:"string" required:"true"`
995110507
995210508 metadataSSHPublicKeyMetadata `json:"-" xml:"-"`
995310509 }
997210528 // action.
997310529 type ServerCertificate struct {
997410530 // The contents of the public key certificate.
9975 CertificateBody *string `type:"string" required:"true"`
10531 CertificateBody *string `min:"1" type:"string" required:"true"`
997610532
997710533 // The contents of the public key certificate chain.
9978 CertificateChain *string `type:"string"`
10534 CertificateChain *string `min:"1" type:"string"`
997910535
998010536 // The meta information of the server certificate, such as its name, path, ID,
998110537 // and ARN.
1000810564 // information about ARNs and how to use them in policies, see IAM Identifiers
1000910565 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1001010566 // in the Using IAM guide.
10011 Arn *string `type:"string" required:"true"`
10567 Arn *string `min:"20" type:"string" required:"true"`
1001210568
1001310569 // The date on which the certificate is set to expire.
1001410570 Expiration *time.Time `type:"timestamp" timestampFormat:"iso8601"`
1001610572 // The path to the server certificate. For more information about paths, see
1001710573 // IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1001810574 // in the Using IAM guide.
10019 Path *string `type:"string" required:"true"`
10575 Path *string `min:"1" type:"string" required:"true"`
1002010576
1002110577 // The stable and unique string identifying the server certificate. For more
1002210578 // information about IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1002310579 // in the Using IAM guide.
10024 ServerCertificateId *string `type:"string" required:"true"`
10580 ServerCertificateId *string `min:"16" type:"string" required:"true"`
1002510581
1002610582 // The name that identifies the server certificate.
10027 ServerCertificateName *string `type:"string" required:"true"`
10583 ServerCertificateName *string `min:"1" type:"string" required:"true"`
1002810584
1002910585 // The date when the server certificate was uploaded.
1003010586 UploadDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
1005210608 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
1005310609 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
1005410610 // in the AWS General Reference.
10055 PolicyArn *string `type:"string" required:"true"`
10611 PolicyArn *string `min:"20" type:"string" required:"true"`
1005610612
1005710613 // The version of the policy to set as the default (operative) version.
1005810614 //
1005910615 // For more information about managed policy versions, see Versioning for Managed
1006010616 // Policies (http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html)
10061 // in the Using IAM guide.
10617 // in the IAM User Guide.
1006210618 VersionId *string `type:"string" required:"true"`
1006310619
1006410620 metadataSetDefaultPolicyVersionInput `json:"-" xml:"-"`
1010210658 // and ListSigningCertificates actions.
1010310659 type SigningCertificate struct {
1010410660 // The contents of the signing certificate.
10105 CertificateBody *string `type:"string" required:"true"`
10661 CertificateBody *string `min:"1" type:"string" required:"true"`
1010610662
1010710663 // The ID for the signing certificate.
10108 CertificateId *string `type:"string" required:"true"`
10664 CertificateId *string `min:"24" type:"string" required:"true"`
1010910665
1011010666 // The status of the signing certificate. Active means the key is valid for
1011110667 // API calls, while Inactive means it is not.
1011510671 UploadDate *time.Time `type:"timestamp" timestampFormat:"iso8601"`
1011610672
1011710673 // The name of the user the signing certificate is associated with.
10118 UserName *string `type:"string" required:"true"`
10674 UserName *string `min:"1" type:"string" required:"true"`
1011910675
1012010676 metadataSigningCertificate `json:"-" xml:"-"`
1012110677 }
1013110687
1013210688 // GoString returns the string representation
1013310689 func (s SigningCertificate) GoString() string {
10690 return s.String()
10691 }
10692
10693 type SimulateCustomPolicyInput struct {
10694 // A list of names of API actions to evaluate in the simulation. Each action
10695 // is evaluated for each resource. Each action must include the service identifier,
10696 // such as iam:CreateUser.
10697 ActionNames []*string `type:"list" required:"true"`
10698
10699 // A list of context keys and corresponding values that are used by the simulation.
10700 // Whenever a context key is evaluated by a Condition element in one of the
10701 // simulated IAM permission policies, the corresponding value is supplied.
10702 ContextEntries []*ContextEntry `type:"list"`
10703
10704 // Use this parameter only when paginating results and only after you receive
10705 // a response indicating that the results are truncated. Set it to the value
10706 // of the Marker element in the response you received to inform the next call
10707 // about where to start.
10708 Marker *string `min:"1" type:"string"`
10709
10710 // Use this only when paginating results to indicate the maximum number of items
10711 // you want in the response. If there are additional items beyond the maximum
10712 // you specify, the IsTruncated response element is true.
10713 //
10714 // This parameter is optional. If you do not include it, it defaults to 100.
10715 // Note that IAM might return fewer results, even when there are more results
10716 // available. If this is the case, the IsTruncated response element returns
10717 // true and Marker contains a value to include in the subsequent call that tells
10718 // the service where to continue from.
10719 MaxItems *int64 `min:"1" type:"integer"`
10720
10721 // A list of policy documents to include in the simulation. Each document is
10722 // specified as a string containing the complete, valid JSON text of an IAM
10723 // policy.
10724 PolicyInputList []*string `type:"list" required:"true"`
10725
10726 // A list of ARNs of AWS resources to include in the simulation. If this parameter
10727 // is not provided then the value defaults to * (all resources). Each API in
10728 // the ActionNames parameter is evaluated for each resource in this list. The
10729 // simulation determines the access result (allowed or denied) of each combination
10730 // and reports it in the response.
10731 ResourceArns []*string `type:"list"`
10732
10733 metadataSimulateCustomPolicyInput `json:"-" xml:"-"`
10734 }
10735
10736 type metadataSimulateCustomPolicyInput struct {
10737 SDKShapeTraits bool `type:"structure"`
10738 }
10739
10740 // String returns the string representation
10741 func (s SimulateCustomPolicyInput) String() string {
10742 return awsutil.Prettify(s)
10743 }
10744
10745 // GoString returns the string representation
10746 func (s SimulateCustomPolicyInput) GoString() string {
10747 return s.String()
10748 }
10749
10750 // Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy
10751 // request.
10752 type SimulatePolicyResponse struct {
10753 // The results of the simulation.
10754 EvaluationResults []*EvaluationResult `type:"list"`
10755
10756 // A flag that indicates whether there are more items to return. If your results
10757 // were truncated, you can make a subsequent pagination request using the Marker
10758 // request parameter to retrieve more items. Note that IAM might return fewer
10759 // than the MaxItems number of results even when there are more results available.
10760 // We recommend that you check IsTruncated after every call to ensure that you
10761 // receive all of your results.
10762 IsTruncated *bool `type:"boolean"`
10763
10764 // When IsTruncated is true, this element is present and contains the value
10765 // to use for the Marker parameter in a subsequent pagination request.
10766 Marker *string `min:"1" type:"string"`
10767
10768 metadataSimulatePolicyResponse `json:"-" xml:"-"`
10769 }
10770
10771 type metadataSimulatePolicyResponse struct {
10772 SDKShapeTraits bool `type:"structure"`
10773 }
10774
10775 // String returns the string representation
10776 func (s SimulatePolicyResponse) String() string {
10777 return awsutil.Prettify(s)
10778 }
10779
10780 // GoString returns the string representation
10781 func (s SimulatePolicyResponse) GoString() string {
10782 return s.String()
10783 }
10784
10785 type SimulatePrincipalPolicyInput struct {
10786 // A list of names of API actions to evaluate in the simulation. Each action
10787 // is evaluated for each resource. Each action must include the service identifier,
10788 // such as iam:CreateUser.
10789 ActionNames []*string `type:"list" required:"true"`
10790
10791 // A list of context keys and corresponding values that are used by the simulation.
10792 // Whenever a context key is evaluated by a Condition element in one of the
10793 // simulated IAM permission policies, the corresponding value is supplied.
10794 ContextEntries []*ContextEntry `type:"list"`
10795
10796 // Use this parameter only when paginating results and only after you receive
10797 // a response indicating that the results are truncated. Set it to the value
10798 // of the Marker element in the response you received to inform the next call
10799 // about where to start.
10800 Marker *string `min:"1" type:"string"`
10801
10802 // Use this only when paginating results to indicate the maximum number of items
10803 // you want in the response. If there are additional items beyond the maximum
10804 // you specify, the IsTruncated response element is true.
10805 //
10806 // This parameter is optional. If you do not include it, it defaults to 100.
10807 // Note that IAM might return fewer results, even when there are more results
10808 // available. If this is the case, the IsTruncated response element returns
10809 // true and Marker contains a value to include in the subsequent call that tells
10810 // the service where to continue from.
10811 MaxItems *int64 `min:"1" type:"integer"`
10812
10813 // An optional list of additional policy documents to include in the simulation.
10814 // Each document is specified as a string containing the complete, valid JSON
10815 // text of an IAM policy.
10816 PolicyInputList []*string `type:"list"`
10817
10818 // The Amazon Resource Name (ARN) of a user, group, or role whose policies you
10819 // want to include in the simulation. If you specify a user, group, or role,
10820 // the simulation includes all policies associated with that entity. If you
10821 // specify a user, the simulation also includes all policies attached to any
10822 // groups the user is a member of.
10823 PolicySourceArn *string `min:"20" type:"string" required:"true"`
10824
10825 // A list of ARNs of AWS resources to include in the simulation. If this parameter
10826 // is not provided then the value defaults to * (all resources). Each API in
10827 // the ActionNames parameter is evaluated for each resource in this list. The
10828 // simulation determines the access result (allowed or denied) of each combination
10829 // and reports it in the response.
10830 ResourceArns []*string `type:"list"`
10831
10832 metadataSimulatePrincipalPolicyInput `json:"-" xml:"-"`
10833 }
10834
10835 type metadataSimulatePrincipalPolicyInput struct {
10836 SDKShapeTraits bool `type:"structure"`
10837 }
10838
10839 // String returns the string representation
10840 func (s SimulatePrincipalPolicyInput) String() string {
10841 return awsutil.Prettify(s)
10842 }
10843
10844 // GoString returns the string representation
10845 func (s SimulatePrincipalPolicyInput) GoString() string {
10846 return s.String()
10847 }
10848
10849 // Contains a reference to a Statement element in a policy document that determines
10850 // the result of the simulation.
10851 //
10852 // This data type is used by the MatchedStatements member of the EvaluationResult
10853 // type.
10854 type Statement struct {
10855 // The row and column of the end of a Statement in an IAM policy.
10856 EndPosition *Position `type:"structure"`
10857
10858 // The identifier of the policy that was provided as an input.
10859 SourcePolicyId *string `type:"string"`
10860
10861 // The type of the policy.
10862 SourcePolicyType *string `type:"string" enum:"PolicySourceType"`
10863
10864 // The row and column of the beginning of the Statement in an IAM policy.
10865 StartPosition *Position `type:"structure"`
10866
10867 metadataStatement `json:"-" xml:"-"`
10868 }
10869
10870 type metadataStatement struct {
10871 SDKShapeTraits bool `type:"structure"`
10872 }
10873
10874 // String returns the string representation
10875 func (s Statement) String() string {
10876 return awsutil.Prettify(s)
10877 }
10878
10879 // GoString returns the string representation
10880 func (s Statement) GoString() string {
1013410881 return s.String()
1013510882 }
1013610883
1013710884 type UpdateAccessKeyInput struct {
1013810885 // The access key ID of the secret access key you want to update.
10139 AccessKeyId *string `type:"string" required:"true"`
10886 AccessKeyId *string `min:"16" type:"string" required:"true"`
1014010887
1014110888 // The status you want to assign to the secret access key. Active means the
1014210889 // key can be used for API calls to AWS, while Inactive means the key cannot
1014410891 Status *string `type:"string" required:"true" enum:"statusType"`
1014510892
1014610893 // The name of the user whose key you want to update.
10147 UserName *string `type:"string"`
10894 UserName *string `min:"1" type:"string"`
1014810895
1014910896 metadataUpdateAccessKeyInput `json:"-" xml:"-"`
1015010897 }
1018510932 // Allows all IAM users in your account to use the AWS Management Console to
1018610933 // change their own passwords. For more information, see Letting IAM Users Change
1018710934 // Their Own Passwords (http://docs.aws.amazon.com/IAM/latest/UserGuide/HowToPwdIAMUser.html)
10188 // in the Using IAM guide.
10935 // in the IAM User Guide.
1018910936 //
1019010937 // Default value: false
1019110938 AllowUsersToChangePassword *bool `type:"boolean"`
1019910946 // of 0 means IAM user passwords never expire.
1020010947 //
1020110948 // Default value: 0
10202 MaxPasswordAge *int64 `type:"integer"`
10949 MaxPasswordAge *int64 `min:"1" type:"integer"`
1020310950
1020410951 // The minimum number of characters allowed in an IAM user password.
1020510952 //
1020610953 // Default value: 6
10207 MinimumPasswordLength *int64 `type:"integer"`
10954 MinimumPasswordLength *int64 `min:"6" type:"integer"`
1020810955
1020910956 // Specifies the number of previous passwords that IAM users are prevented from
1021010957 // reusing. The default value of 0 means IAM users are not prevented from reusing
1021110958 // previous passwords.
1021210959 //
1021310960 // Default value: 0
10214 PasswordReusePrevention *int64 `type:"integer"`
10961 PasswordReusePrevention *int64 `min:"1" type:"integer"`
1021510962
1021610963 // Specifies whether IAM user passwords must contain at least one lowercase
1021710964 // character from the ISO basic Latin alphabet (a to z).
1027611023
1027711024 type UpdateAssumeRolePolicyInput struct {
1027811025 // The policy that grants an entity permission to assume the role.
10279 PolicyDocument *string `type:"string" required:"true"`
11026 PolicyDocument *string `min:"1" type:"string" required:"true"`
1028011027
1028111028 // The name of the role to update.
10282 RoleName *string `type:"string" required:"true"`
11029 RoleName *string `min:"1" type:"string" required:"true"`
1028311030
1028411031 metadataUpdateAssumeRolePolicyInput `json:"-" xml:"-"`
1028511032 }
1031911066 type UpdateGroupInput struct {
1032011067 // Name of the group to update. If you're changing the name of the group, this
1032111068 // is the original name.
10322 GroupName *string `type:"string" required:"true"`
11069 GroupName *string `min:"1" type:"string" required:"true"`
1032311070
1032411071 // New name for the group. Only include this if changing the group's name.
10325 NewGroupName *string `type:"string"`
11072 NewGroupName *string `min:"1" type:"string"`
1032611073
1032711074 // New path for the group. Only include this if changing the group's path.
10328 NewPath *string `type:"string"`
11075 NewPath *string `min:"1" type:"string"`
1032911076
1033011077 metadataUpdateGroupInput `json:"-" xml:"-"`
1033111078 }
1036411111
1036511112 type UpdateLoginProfileInput struct {
1036611113 // The new password for the specified user.
10367 Password *string `type:"string"`
11114 Password *string `min:"1" type:"string"`
1036811115
1036911116 // Require the specified user to set a new password on next sign-in.
1037011117 PasswordResetRequired *bool `type:"boolean"`
1037111118
1037211119 // The name of the user whose password you want to update.
10373 UserName *string `type:"string" required:"true"`
11120 UserName *string `min:"1" type:"string" required:"true"`
1037411121
1037511122 metadataUpdateLoginProfileInput `json:"-" xml:"-"`
1037611123 }
1041111158 // The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider
1041211159 // to update the thumbprint for. You can get a list of OIDC provider ARNs by
1041311160 // using the ListOpenIDConnectProviders action.
10414 OpenIDConnectProviderArn *string `type:"string" required:"true"`
11161 OpenIDConnectProviderArn *string `min:"20" type:"string" required:"true"`
1041511162
1041611163 // A list of certificate thumbprints that are associated with the specified
1041711164 // IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.
1045811205 // keys that can be used to validate the SAML authentication response (assertions)
1045911206 // that are received from the IdP. You must generate the metadata document using
1046011207 // the identity management software that is used as your organization's IdP.
10461 SAMLMetadataDocument *string `type:"string" required:"true"`
11208 SAMLMetadataDocument *string `min:"1000" type:"string" required:"true"`
1046211209
1046311210 // The Amazon Resource Name (ARN) of the SAML provider to update.
10464 SAMLProviderArn *string `type:"string" required:"true"`
11211 SAMLProviderArn *string `min:"20" type:"string" required:"true"`
1046511212
1046611213 metadataUpdateSAMLProviderInput `json:"-" xml:"-"`
1046711214 }
1048311230 // Contains the response to a successful UpdateSAMLProvider request.
1048411231 type UpdateSAMLProviderOutput struct {
1048511232 // The Amazon Resource Name (ARN) of the SAML provider that was updated.
10486 SAMLProviderArn *string `type:"string"`
11233 SAMLProviderArn *string `min:"20" type:"string"`
1048711234
1048811235 metadataUpdateSAMLProviderOutput `json:"-" xml:"-"`
1048911236 }
1050411251
1050511252 type UpdateSSHPublicKeyInput struct {
1050611253 // The unique identifier for the SSH public key.
10507 SSHPublicKeyId *string `type:"string" required:"true"`
11254 SSHPublicKeyId *string `min:"20" type:"string" required:"true"`
1050811255
1050911256 // The status to assign to the SSH public key. Active means the key can be used
1051011257 // for authentication with an AWS CodeCommit repository. Inactive means the
1051211259 Status *string `type:"string" required:"true" enum:"statusType"`
1051311260
1051411261 // The name of the IAM user associated with the SSH public key.
10515 UserName *string `type:"string" required:"true"`
11262 UserName *string `min:"1" type:"string" required:"true"`
1051611263
1051711264 metadataUpdateSSHPublicKeyInput `json:"-" xml:"-"`
1051811265 }
1055211299 type UpdateServerCertificateInput struct {
1055311300 // The new path for the server certificate. Include this only if you are updating
1055411301 // the server certificate's path.
10555 NewPath *string `type:"string"`
11302 NewPath *string `min:"1" type:"string"`
1055611303
1055711304 // The new name for the server certificate. Include this only if you are updating
1055811305 // the server certificate's name. The name of the certificate cannot contain
1055911306 // any spaces.
10560 NewServerCertificateName *string `type:"string"`
11307 NewServerCertificateName *string `min:"1" type:"string"`
1056111308
1056211309 // The name of the server certificate that you want to update.
10563 ServerCertificateName *string `type:"string" required:"true"`
11310 ServerCertificateName *string `min:"1" type:"string" required:"true"`
1056411311
1056511312 metadataUpdateServerCertificateInput `json:"-" xml:"-"`
1056611313 }
1059911346
1060011347 type UpdateSigningCertificateInput struct {
1060111348 // The ID of the signing certificate you want to update.
10602 CertificateId *string `type:"string" required:"true"`
11349 CertificateId *string `min:"24" type:"string" required:"true"`
1060311350
1060411351 // The status you want to assign to the certificate. Active means the certificate
1060511352 // can be used for API calls to AWS, while Inactive means the certificate cannot
1060711354 Status *string `type:"string" required:"true" enum:"statusType"`
1060811355
1060911356 // The name of the user the signing certificate belongs to.
10610 UserName *string `type:"string"`
11357 UserName *string `min:"1" type:"string"`
1061111358
1061211359 metadataUpdateSigningCertificateInput `json:"-" xml:"-"`
1061311360 }
1064711394 type UpdateUserInput struct {
1064811395 // New path for the user. Include this parameter only if you're changing the
1064911396 // user's path.
10650 NewPath *string `type:"string"`
11397 NewPath *string `min:"1" type:"string"`
1065111398
1065211399 // New name for the user. Include this parameter only if you're changing the
1065311400 // user's name.
10654 NewUserName *string `type:"string"`
11401 NewUserName *string `min:"1" type:"string"`
1065511402
1065611403 // Name of the user to update. If you're changing the name of the user, this
1065711404 // is the original user name.
10658 UserName *string `type:"string" required:"true"`
11405 UserName *string `min:"1" type:"string" required:"true"`
1065911406
1066011407 metadataUpdateUserInput `json:"-" xml:"-"`
1066111408 }
1069511442 type UploadSSHPublicKeyInput struct {
1069611443 // The SSH public key. The public key must be encoded in ssh-rsa format or PEM
1069711444 // format.
10698 SSHPublicKeyBody *string `type:"string" required:"true"`
11445 SSHPublicKeyBody *string `min:"1" type:"string" required:"true"`
1069911446
1070011447 // The name of the IAM user to associate the SSH public key with.
10701 UserName *string `type:"string" required:"true"`
11448 UserName *string `min:"1" type:"string" required:"true"`
1070211449
1070311450 metadataUploadSSHPublicKeyInput `json:"-" xml:"-"`
1070411451 }
1074111488
1074211489 type UploadServerCertificateInput struct {
1074311490 // The contents of the public key certificate in PEM-encoded format.
10744 CertificateBody *string `type:"string" required:"true"`
11491 CertificateBody *string `min:"1" type:"string" required:"true"`
1074511492
1074611493 // The contents of the certificate chain. This is typically a concatenation
1074711494 // of the PEM-encoded public key certificates of the chain.
10748 CertificateChain *string `type:"string"`
11495 CertificateChain *string `min:"1" type:"string"`
1074911496
1075011497 // The path for the server certificate. For more information about paths, see
1075111498 // IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1075811505 // CloudFront distributions, you must specify a path using the --path option.
1075911506 // The path must begin with /cloudfront and must include a trailing slash (for
1076011507 // example, /cloudfront/test/).
10761 Path *string `type:"string"`
11508 Path *string `min:"1" type:"string"`
1076211509
1076311510 // The contents of the private key in PEM-encoded format.
10764 PrivateKey *string `type:"string" required:"true"`
11511 PrivateKey *string `min:"1" type:"string" required:"true"`
1076511512
1076611513 // The name for the server certificate. Do not include the path in this value.
1076711514 // The name of the certificate cannot contain any spaces.
10768 ServerCertificateName *string `type:"string" required:"true"`
11515 ServerCertificateName *string `min:"1" type:"string" required:"true"`
1076911516
1077011517 metadataUploadServerCertificateInput `json:"-" xml:"-"`
1077111518 }
1080911556
1081011557 type UploadSigningCertificateInput struct {
1081111558 // The contents of the signing certificate.
10812 CertificateBody *string `type:"string" required:"true"`
11559 CertificateBody *string `min:"1" type:"string" required:"true"`
1081311560
1081411561 // The name of the user the signing certificate is for.
10815 UserName *string `type:"string"`
11562 UserName *string `min:"1" type:"string"`
1081611563
1081711564 metadataUploadSigningCertificateInput `json:"-" xml:"-"`
1081811565 }
1086611613 // The Amazon Resource Name (ARN) that identifies the user. For more information
1086711614 // about ARNs and how to use ARNs in policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1086811615 // in the Using IAM guide.
10869 Arn *string `type:"string" required:"true"`
11616 Arn *string `min:"20" type:"string" required:"true"`
1087011617
1087111618 // The date and time, in ISO 8601 date-time format (http://www.iso.org/iso/iso8601),
1087211619 // when the user was created.
1089311640 // The path to the user. For more information about paths, see IAM Identifiers
1089411641 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1089511642 // in the Using IAM guide.
10896 Path *string `type:"string" required:"true"`
11643 Path *string `min:"1" type:"string" required:"true"`
1089711644
1089811645 // The stable and unique string identifying the user. For more information about
1089911646 // IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1090011647 // in the Using IAM guide.
10901 UserId *string `type:"string" required:"true"`
11648 UserId *string `min:"16" type:"string" required:"true"`
1090211649
1090311650 // The friendly name identifying the user.
10904 UserName *string `type:"string" required:"true"`
11651 UserName *string `min:"1" type:"string" required:"true"`
1090511652
1090611653 metadataUser `json:"-" xml:"-"`
1090711654 }
1093111678 // For more information about ARNs, go to Amazon Resource Names (ARNs) and
1093211679 // AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html)
1093311680 // in the AWS General Reference.
10934 Arn *string `type:"string"`
11681 Arn *string `min:"20" type:"string"`
1093511682
1093611683 // A list of the managed policies attached to the user.
1093711684 AttachedManagedPolicies []*AttachedPolicy `type:"list"`
1094611693 // The path to the user. For more information about paths, see IAM Identifiers
1094711694 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1094811695 // in the Using IAM guide.
10949 Path *string `type:"string"`
11696 Path *string `min:"1" type:"string"`
1095011697
1095111698 // The stable and unique string identifying the user. For more information about
1095211699 // IDs, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html)
1095311700 // in the Using IAM guide.
10954 UserId *string `type:"string"`
11701 UserId *string `min:"16" type:"string"`
1095511702
1095611703 // The friendly name identifying the user.
10957 UserName *string `type:"string"`
11704 UserName *string `min:"1" type:"string"`
1095811705
1095911706 // A list of the inline policies embedded in the user.
1096011707 UserPolicyList []*PolicyDetail `type:"list"`
1099211739 QRCodePNG []byte `type:"blob"`
1099311740
1099411741 // The serial number associated with VirtualMFADevice.
10995 SerialNumber *string `type:"string" required:"true"`
11742 SerialNumber *string `min:"9" type:"string" required:"true"`
1099611743
1099711744 // Contains information about an IAM user entity.
1099811745 //
1102111768 func (s VirtualMFADevice) GoString() string {
1102211769 return s.String()
1102311770 }
11771
11772 const (
11773 // @enum ContextKeyTypeEnum
11774 ContextKeyTypeEnumString = "string"
11775 // @enum ContextKeyTypeEnum
11776 ContextKeyTypeEnumStringList = "stringList"
11777 // @enum ContextKeyTypeEnum
11778 ContextKeyTypeEnumNumeric = "numeric"
11779 // @enum ContextKeyTypeEnum
11780 ContextKeyTypeEnumNumericList = "numericList"
11781 // @enum ContextKeyTypeEnum
11782 ContextKeyTypeEnumBoolean = "boolean"
11783 // @enum ContextKeyTypeEnum
11784 ContextKeyTypeEnumBooleanList = "booleanList"
11785 // @enum ContextKeyTypeEnum
11786 ContextKeyTypeEnumIp = "ip"
11787 // @enum ContextKeyTypeEnum
11788 ContextKeyTypeEnumIpList = "ipList"
11789 // @enum ContextKeyTypeEnum
11790 ContextKeyTypeEnumBinary = "binary"
11791 // @enum ContextKeyTypeEnum
11792 ContextKeyTypeEnumBinaryList = "binaryList"
11793 // @enum ContextKeyTypeEnum
11794 ContextKeyTypeEnumDate = "date"
11795 // @enum ContextKeyTypeEnum
11796 ContextKeyTypeEnumDateList = "dateList"
11797 )
1102411798
1102511799 const (
1102611800 // @enum EntityType
1103311807 EntityTypeLocalManagedPolicy = "LocalManagedPolicy"
1103411808 // @enum EntityType
1103511809 EntityTypeAwsmanagedPolicy = "AWSManagedPolicy"
11810 )
11811
11812 const (
11813 // @enum PolicyEvaluationDecisionType
11814 PolicyEvaluationDecisionTypeAllowed = "allowed"
11815 // @enum PolicyEvaluationDecisionType
11816 PolicyEvaluationDecisionTypeExplicitDeny = "explicitDeny"
11817 // @enum PolicyEvaluationDecisionType
11818 PolicyEvaluationDecisionTypeImplicitDeny = "implicitDeny"
11819 )
11820
11821 const (
11822 // @enum PolicySourceType
11823 PolicySourceTypeUser = "user"
11824 // @enum PolicySourceType
11825 PolicySourceTypeGroup = "group"
11826 // @enum PolicySourceType
11827 PolicySourceTypeRole = "role"
11828 // @enum PolicySourceType
11829 PolicySourceTypeAwsManaged = "aws-managed"
11830 // @enum PolicySourceType
11831 PolicySourceTypeUserManaged = "user-managed"
11832 // @enum PolicySourceType
11833 PolicySourceTypeNone = "none"
1103611834 )
1103711835
1103811836 const (
+132
-0
service/iam/examples_test.go less more
965965 fmt.Println(resp)
966966 }
967967
968 func ExampleIAM_GetContextKeysForCustomPolicy() {
969 svc := iam.New(nil)
970
971 params := &iam.GetContextKeysForCustomPolicyInput{
972 PolicyInputList: []*string{ // Required
973 aws.String("policyDocumentType"), // Required
974 // More values...
975 },
976 }
977 resp, err := svc.GetContextKeysForCustomPolicy(params)
978
979 if err != nil {
980 // Print the error, cast err to awserr.Error to get the Code and
981 // Message from an error.
982 fmt.Println(err.Error())
983 return
984 }
985
986 // Pretty-print the response data.
987 fmt.Println(resp)
988 }
989
990 func ExampleIAM_GetContextKeysForPrincipalPolicy() {
991 svc := iam.New(nil)
992
993 params := &iam.GetContextKeysForPrincipalPolicyInput{
994 PolicySourceArn: aws.String("arnType"), // Required
995 PolicyInputList: []*string{
996 aws.String("policyDocumentType"), // Required
997 // More values...
998 },
999 }
1000 resp, err := svc.GetContextKeysForPrincipalPolicy(params)
1001
1002 if err != nil {
1003 // Print the error, cast err to awserr.Error to get the Code and
1004 // Message from an error.
1005 fmt.Println(err.Error())
1006 return
1007 }
1008
1009 // Pretty-print the response data.
1010 fmt.Println(resp)
1011 }
1012
9681013 func ExampleIAM_GetCredentialReport() {
9691014 svc := iam.New(nil)
9701015
19111956 VersionId: aws.String("policyVersionIdType"), // Required
19121957 }
19131958 resp, err := svc.SetDefaultPolicyVersion(params)
1959
1960 if err != nil {
1961 // Print the error, cast err to awserr.Error to get the Code and
1962 // Message from an error.
1963 fmt.Println(err.Error())
1964 return
1965 }
1966
1967 // Pretty-print the response data.
1968 fmt.Println(resp)
1969 }
1970
1971 func ExampleIAM_SimulateCustomPolicy() {
1972 svc := iam.New(nil)
1973
1974 params := &iam.SimulateCustomPolicyInput{
1975 ActionNames: []*string{ // Required
1976 aws.String("ActionNameType"), // Required
1977 // More values...
1978 },
1979 PolicyInputList: []*string{ // Required
1980 aws.String("policyDocumentType"), // Required
1981 // More values...
1982 },
1983 ContextEntries: []*iam.ContextEntry{
1984 { // Required
1985 ContextKeyName: aws.String("ContextKeyNameType"),
1986 ContextKeyType: aws.String("ContextKeyTypeEnum"),
1987 ContextKeyValues: []*string{
1988 aws.String("ContextKeyValueType"), // Required
1989 // More values...
1990 },
1991 },
1992 // More values...
1993 },
1994 Marker: aws.String("markerType"),
1995 MaxItems: aws.Int64(1),
1996 ResourceArns: []*string{
1997 aws.String("ResourceNameType"), // Required
1998 // More values...
1999 },
2000 }
2001 resp, err := svc.SimulateCustomPolicy(params)
2002
2003 if err != nil {
2004 // Print the error, cast err to awserr.Error to get the Code and
2005 // Message from an error.
2006 fmt.Println(err.Error())
2007 return
2008 }
2009
2010 // Pretty-print the response data.
2011 fmt.Println(resp)
2012 }
2013
2014 func ExampleIAM_SimulatePrincipalPolicy() {
2015 svc := iam.New(nil)
2016
2017 params := &iam.SimulatePrincipalPolicyInput{
2018 ActionNames: []*string{ // Required
2019 aws.String("ActionNameType"), // Required
2020 // More values...
2021 },
2022 PolicySourceArn: aws.String("arnType"), // Required
2023 ContextEntries: []*iam.ContextEntry{
2024 { // Required
2025 ContextKeyName: aws.String("ContextKeyNameType"),
2026 ContextKeyType: aws.String("ContextKeyTypeEnum"),
2027 ContextKeyValues: []*string{
2028 aws.String("ContextKeyValueType"), // Required
2029 // More values...
2030 },
2031 },
2032 // More values...
2033 },
2034 Marker: aws.String("markerType"),
2035 MaxItems: aws.Int64(1),
2036 PolicyInputList: []*string{
2037 aws.String("policyDocumentType"), // Required
2038 // More values...
2039 },
2040 ResourceArns: []*string{
2041 aws.String("ResourceNameType"), // Required
2042 // More values...
2043 },
2044 }
2045 resp, err := svc.SimulatePrincipalPolicy(params)
19142046
19152047 if err != nil {
19162048 // Print the error, cast err to awserr.Error to get the Code and
+16
-0
service/iam/iamiface/interface.go less more
203203
204204 GetAccountSummary(*iam.GetAccountSummaryInput) (*iam.GetAccountSummaryOutput, error)
205205
206 GetContextKeysForCustomPolicyRequest(*iam.GetContextKeysForCustomPolicyInput) (*request.Request, *iam.GetContextKeysForPolicyResponse)
207
208 GetContextKeysForCustomPolicy(*iam.GetContextKeysForCustomPolicyInput) (*iam.GetContextKeysForPolicyResponse, error)
209
210 GetContextKeysForPrincipalPolicyRequest(*iam.GetContextKeysForPrincipalPolicyInput) (*request.Request, *iam.GetContextKeysForPolicyResponse)
211
212 GetContextKeysForPrincipalPolicy(*iam.GetContextKeysForPrincipalPolicyInput) (*iam.GetContextKeysForPolicyResponse, error)
213
206214 GetCredentialReportRequest(*iam.GetCredentialReportInput) (*request.Request, *iam.GetCredentialReportOutput)
207215
208216 GetCredentialReport(*iam.GetCredentialReportInput) (*iam.GetCredentialReportOutput, error)
432440 SetDefaultPolicyVersionRequest(*iam.SetDefaultPolicyVersionInput) (*request.Request, *iam.SetDefaultPolicyVersionOutput)
433441
434442 SetDefaultPolicyVersion(*iam.SetDefaultPolicyVersionInput) (*iam.SetDefaultPolicyVersionOutput, error)
443
444 SimulateCustomPolicyRequest(*iam.SimulateCustomPolicyInput) (*request.Request, *iam.SimulatePolicyResponse)
445
446 SimulateCustomPolicy(*iam.SimulateCustomPolicyInput) (*iam.SimulatePolicyResponse, error)
447
448 SimulatePrincipalPolicyRequest(*iam.SimulatePrincipalPolicyInput) (*request.Request, *iam.SimulatePolicyResponse)
449
450 SimulatePrincipalPolicy(*iam.SimulatePrincipalPolicyInput) (*iam.SimulatePolicyResponse, error)
435451
436452 UpdateAccessKeyRequest(*iam.UpdateAccessKeyInput) (*request.Request, *iam.UpdateAccessKeyOutput)
437453
+1
-3
service/iam/service.go less more
5656 // This topic provides general information about the types of credentials used
5757 // for accessing AWS. IAM Best Practices (http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html).
5858 // This topic presents a list of suggestions for using the IAM service to help
59 // secure your AWS resources. AWS Security Token Service (http://docs.aws.amazon.com/STS/latest/UsingSTS/).
60 // This guide describes how to create and use temporary security credentials.
61 // Signing AWS API Requests (http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html).
59 // secure your AWS resources. Signing AWS API Requests (http://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html).
6260 // This set of topics walk you through the process of signing a request using
6361 // an access key ID and secret access key.
6462 type IAM struct {
+99
-81
service/kinesis/api.go less more
33 package kinesis
44
55 import (
6 "time"
7
68 "github.com/aws/aws-sdk-go/aws/awsutil"
79 "github.com/aws/aws-sdk-go/aws/request"
810 )
6567 // stream.
6668 //
6769 // You specify and control the number of shards that a stream is composed of.
68 // Each open shard can support up to 5 read transactions per second, up to a
69 // maximum total of 2 MB of data read per second. Each shard can support up
70 // to 1000 records written per second, up to a maximum total of 1 MB data written
71 // per second. You can add shards to a stream if the amount of data input increases
72 // and you can remove shards if the amount of data input decreases.
70 // Each shard can support reads up to 5 transactions per second, up to a maximum
71 // data read total of 2 MB per second. Each shard can support writes up to 1,000
72 // records per second, up to a maximum data write total of 1 MB per second.
73 // You can add shards to a stream if the amount of data input increases and
74 // you can remove shards if the amount of data input decreases.
7375 //
7476 // The stream name identifies the stream. The name is scoped to the AWS account
7577 // used by the application. It is also scoped by region. That is, two streams
8890 // Have more than five streams in the CREATING state at any point in time.
8991 // Create more shards than are authorized for your account. For the default
9092 // shard limit for an AWS account, see Amazon Kinesis Limits (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html).
91 // If you need to increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
93 // If you need to increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).
9294 //
9395 // You can use DescribeStream to check the stream status, which is returned
9496 // in StreamStatus.
247249 // the sequence number or other attribute that marks it as the last record to
248250 // process.
249251 //
250 // Each data record can be up to 50 KB in size, and each shard can read up
251 // to 2 MB per second. You can ensure that your calls don't exceed the maximum
252 // Each data record can be up to 1 MB in size, and each shard can read up to
253 // 2 MB per second. You can ensure that your calls don't exceed the maximum
252254 // supported size or throughput by using the Limit parameter to specify the
253255 // maximum number of records that GetRecords can return. Consider your average
254 // record size when determining this limit. For example, if your average record
255 // size is 40 KB, you can limit the data returned to about 1 MB per call by
256 // specifying 25 as the limit.
256 // record size when determining this limit.
257257 //
258258 // The size of the data returned by GetRecords will vary depending on the utilization
259259 // of the shard. The maximum size of data that GetRecords can return is 10 MB.
266266 // that the application will get exceptions for longer than 1 second.
267267 //
268268 // To detect whether the application is falling behind in processing, you can
269 // use the MillisBehindLatest response attribute. You can also monitor the amount
270 // of data in a stream using the CloudWatch metrics. For more information, see
271 // Monitoring Amazon Kinesis with Amazon CloudWatch (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring_with_cloudwatch.html)
272 // in the Amazon Kinesis Developer Guide.
269 // use the MillisBehindLatest response attribute. You can also monitor the stream
270 // using CloudWatch metrics (see Monitoring Amazon Kinesis (http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html)
271 // in the Amazon Kinesis Developer Guide).
272 //
273 // Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp,
274 // that is set when an Amazon Kinesis stream successfully receives and stores
275 // a record. This is commonly referred to as a server-side timestamp, which
276 // is different than a client-side timestamp, where the timestamp is set when
277 // a data producer creates or sends the record to a stream. The timestamp has
278 // millisecond precision. There are no guarantees about the timestamp accuracy,
279 // or that the timestamp is always increasing. For example, records in a shard
280 // or across a stream might have timestamps that are out of order.
273281 func (c *Kinesis) GetRecords(input *GetRecordsInput) (*GetRecordsOutput, error) {
274282 req, out := c.GetRecordsRequest(input)
275283 err := req.Send()
502510 return
503511 }
504512
505 // Puts (writes) a single data record from a producer into an Amazon Kinesis
506 // stream. Call PutRecord to send data from the producer into the Amazon Kinesis
507 // stream for real-time ingestion and subsequent processing, one record at a
508 // time. Each shard can support up to 1000 records written per second, up to
509 // a maximum total of 1 MB data written per second.
513 // Writes a single data record from a producer into an Amazon Kinesis stream.
514 // Call PutRecord to send data from the producer into the Amazon Kinesis stream
515 // for real-time ingestion and subsequent processing, one record at a time.
516 // Each shard can support writes up to 1,000 records per second, up to a maximum
517 // data write total of 1 MB per second.
510518 //
511519 // You must specify the name of the stream that captures, stores, and transports
512520 // the data; a partition key; and the data blob itself.
524532 // integer values and to map associated data records to shards using the hash
525533 // key ranges of the shards. You can override hashing the partition key to determine
526534 // the shard by explicitly specifying a hash value using the ExplicitHashKey
527 // parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html)
535 // parameter. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
528536 // in the Amazon Kinesis Developer Guide.
529537 //
530538 // PutRecord returns the shard ID of where the data record was placed and the
532540 //
533541 // Sequence numbers generally increase over time. To guarantee strictly increasing
534542 // ordering, use the SequenceNumberForOrdering parameter. For more information,
535 // see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html)
543 // see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
536544 // in the Amazon Kinesis Developer Guide.
537545 //
538546 // If a PutRecord request cannot be processed because of insufficient provisioned
566574 return
567575 }
568576
569 // Puts (writes) multiple data records from a producer into an Amazon Kinesis
570 // stream in a single call (also referred to as a PutRecords request). Use this
571 // operation to send data from a data producer into the Amazon Kinesis stream
572 // for real-time ingestion and processing. Each shard can support up to 1000
573 // records written per second, up to a maximum total of 1 MB data written per
574 // second.
577 // Writes multiple data records from a producer into an Amazon Kinesis stream
578 // in a single call (also referred to as a PutRecords request). Use this operation
579 // to send data from a data producer into the Amazon Kinesis stream for data
580 // ingestion and processing.
581 //
582 // Each PutRecords request can support up to 500 records. Each record in the
583 // request can be as large as 1 MB, up to a limit of 5 MB for the entire request,
584 // including partition keys. Each shard can support writes up to 1,000 records
585 // per second, up to a maximum data write total of 1 MB per second.
575586 //
576587 // You must specify the name of the stream that captures, stores, and transports
577588 // the data; and an array of request Records, with each record in the array
578 // requiring a partition key and data blob.
589 // requiring a partition key and data blob. The record size limit applies to
590 // the total size of the partition key and data blob.
579591 //
580592 // The data blob can be any type of data; for example, a segment from a log
581593 // file, geographic/location data, website clickstream data, and so on.
585597 // hash function is used to map partition keys to 128-bit integer values and
586598 // to map associated data records to shards. As a result of this hashing mechanism,
587599 // all data records with the same partition key map to the same shard within
588 // the stream. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html)
600 // the stream. For more information, see Adding Data to a Stream (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream)
589601 // in the Amazon Kinesis Developer Guide.
590602 //
591603 // Each record in the Records array may include an optional parameter, ExplicitHashKey,
592604 // which overrides the partition key to shard mapping. This parameter allows
593605 // a data producer to determine explicitly the shard where the record is stored.
594 // For more information, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords)
606 // For more information, see Adding Multiple Records with PutRecords (http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords)
595607 // in the Amazon Kinesis Developer Guide.
596608 //
597609 // The PutRecords response includes an array of response Records. Each record
716728 //
717729 // For the default shard limit for an AWS account, see Amazon Kinesis Limits
718730 // (http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html).
719 // If you need to increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html)
731 // If you need to increase this limit, contact AWS Support (http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html).
720732 //
721733 // If you try to operate on too many streams in parallel using CreateStream,
722734 // DeleteStream, MergeShards or SplitShard, you receive a LimitExceededException.
731743 // Represents the input for AddTagsToStream.
732744 type AddTagsToStreamInput struct {
733745 // The name of the stream.
734 StreamName *string `type:"string" required:"true"`
746 StreamName *string `min:"1" type:"string" required:"true"`
735747
736748 // The set of key-value pairs to use to create the tags.
737 Tags map[string]*string `type:"map" required:"true"`
749 Tags map[string]*string `min:"1" type:"map" required:"true"`
738750
739751 metadataAddTagsToStreamInput `json:"-" xml:"-"`
740752 }
778790 // provisioned throughput.
779791 //
780792 // DefaultShardLimit;
781 ShardCount *int64 `type:"integer" required:"true"`
793 ShardCount *int64 `min:"1" type:"integer" required:"true"`
782794
783795 // A name to identify the stream. The stream name is scoped to the AWS account
784796 // used by the application that creates the stream. It is also scoped by region.
785797 // That is, two streams in two different AWS accounts can have the same name,
786798 // and two streams in the same AWS account, but in two different regions, can
787799 // have the same name.
788 StreamName *string `type:"string" required:"true"`
800 StreamName *string `min:"1" type:"string" required:"true"`
789801
790802 metadataCreateStreamInput `json:"-" xml:"-"`
791803 }
825837 // Represents the input for DeleteStream.
826838 type DeleteStreamInput struct {
827839 // The name of the stream to delete.
828 StreamName *string `type:"string" required:"true"`
840 StreamName *string `min:"1" type:"string" required:"true"`
829841
830842 metadataDeleteStreamInput `json:"-" xml:"-"`
831843 }
865877 // Represents the input for DescribeStream.
866878 type DescribeStreamInput struct {
867879 // The shard ID of the shard to start with.
868 ExclusiveStartShardId *string `type:"string"`
880 ExclusiveStartShardId *string `min:"1" type:"string"`
869881
870882 // The maximum number of shards to return.
871 Limit *int64 `type:"integer"`
883 Limit *int64 `min:"1" type:"integer"`
872884
873885 // The name of the stream to describe.
874 StreamName *string `type:"string" required:"true"`
886 StreamName *string `min:"1" type:"string" required:"true"`
875887
876888 metadataDescribeStreamInput `json:"-" xml:"-"`
877889 }
917929 type GetRecordsInput struct {
918930 // The maximum number of records to return. Specify a value of up to 10,000.
919931 // If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.
920 Limit *int64 `type:"integer"`
932 Limit *int64 `min:"1" type:"integer"`
921933
922934 // The position in the shard from which you want to start sequentially reading
923935 // data records. A shard iterator specifies this position using the sequence
924936 // number of a data record in the shard.
925 ShardIterator *string `type:"string" required:"true"`
937 ShardIterator *string `min:"1" type:"string" required:"true"`
926938
927939 metadataGetRecordsInput `json:"-" xml:"-"`
928940 }
952964 // The next position in the shard from which to start sequentially reading data
953965 // records. If set to null, the shard has been closed and the requested iterator
954966 // will not return any more data.
955 NextShardIterator *string `type:"string"`
967 NextShardIterator *string `min:"1" type:"string"`
956968
957969 // The data records retrieved from the shard.
958970 Records []*Record `type:"list" required:"true"`
977989 // Represents the input for GetShardIterator.
978990 type GetShardIteratorInput struct {
979991 // The shard ID of the shard to get the iterator for.
980 ShardId *string `type:"string" required:"true"`
992 ShardId *string `min:"1" type:"string" required:"true"`
981993
982994 // Determines how the shard iterator is used to start reading data records from
983995 // the shard.
9981010 StartingSequenceNumber *string `type:"string"`
9991011
10001012 // The name of the stream.
1001 StreamName *string `type:"string" required:"true"`
1013 StreamName *string `min:"1" type:"string" required:"true"`
10021014
10031015 metadataGetShardIteratorInput `json:"-" xml:"-"`
10041016 }
10221034 // The position in the shard from which to start reading data records sequentially.
10231035 // A shard iterator specifies this position using the sequence number of a data
10241036 // record in a shard.
1025 ShardIterator *string `type:"string"`
1037 ShardIterator *string `min:"1" type:"string"`
10261038
10271039 metadataGetShardIteratorOutput `json:"-" xml:"-"`
10281040 }
10701082 // Represents the input for ListStreams.
10711083 type ListStreamsInput struct {
10721084 // The name of the stream to start the list with.
1073 ExclusiveStartStreamName *string `type:"string"`
1085 ExclusiveStartStreamName *string `min:"1" type:"string"`
10741086
10751087 // The maximum number of streams to list.
1076 Limit *int64 `type:"integer"`
1088 Limit *int64 `min:"1" type:"integer"`
10771089
10781090 metadataListStreamsInput `json:"-" xml:"-"`
10791091 }
11221134 type ListTagsForStreamInput struct {
11231135 // The key to use as the starting point for the list of tags. If this parameter
11241136 // is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.
1125 ExclusiveStartTagKey *string `type:"string"`
1137 ExclusiveStartTagKey *string `min:"1" type:"string"`
11261138
11271139 // The number of tags to return. If this number is less than the total number
11281140 // of tags associated with the stream, HasMoreTags is set to true. To list additional
11291141 // tags, set ExclusiveStartTagKey to the last key in the response.
1130 Limit *int64 `type:"integer"`
1142 Limit *int64 `min:"1" type:"integer"`
11311143
11321144 // The name of the stream.
1133 StreamName *string `type:"string" required:"true"`
1145 StreamName *string `min:"1" type:"string" required:"true"`
11341146
11351147 metadataListTagsForStreamInput `json:"-" xml:"-"`
11361148 }
11791191 // Represents the input for MergeShards.
11801192 type MergeShardsInput struct {
11811193 // The shard ID of the adjacent shard for the merge.
1182 AdjacentShardToMerge *string `type:"string" required:"true"`
1194 AdjacentShardToMerge *string `min:"1" type:"string" required:"true"`
11831195
11841196 // The shard ID of the shard to combine with the adjacent shard for the merge.
1185 ShardToMerge *string `type:"string" required:"true"`
1197 ShardToMerge *string `min:"1" type:"string" required:"true"`
11861198
11871199 // The name of the stream for the merge.
1188 StreamName *string `type:"string" required:"true"`
1200 StreamName *string `min:"1" type:"string" required:"true"`
11891201
11901202 metadataMergeShardsInput `json:"-" xml:"-"`
11911203 }
12251237 // Represents the input for PutRecord.
12261238 type PutRecordInput struct {
12271239 // The data blob to put into the record, which is base64-encoded when the blob
1228 // is serialized. The maximum size of the data blob (the payload before base64-encoding)
1229 // is 50 kilobytes (KB)
1240 // is serialized. When the data blob (the payload before base64-encoding) is
1241 // added to the partition key size, the total size must not exceed the maximum
1242 // record size (1 MB).
12301243 Data []byte `type:"blob" required:"true"`
12311244
12321245 // The hash value used to explicitly determine the shard the data record is
12411254 // and to map associated data records to shards. As a result of this hashing
12421255 // mechanism, all data records with the same partition key will map to the same
12431256 // shard within the stream.
1244 PartitionKey *string `type:"string" required:"true"`
1257 PartitionKey *string `min:"1" type:"string" required:"true"`
12451258
12461259 // Guarantees strictly increasing sequence numbers, for puts from the same client
12471260 // and to the same partition key. Usage: set the SequenceNumberForOrdering of
12511264 SequenceNumberForOrdering *string `type:"string"`
12521265
12531266 // The name of the stream to put the data record into.
1254 StreamName *string `type:"string" required:"true"`
1267 StreamName *string `min:"1" type:"string" required:"true"`
12551268
12561269 metadataPutRecordInput `json:"-" xml:"-"`
12571270 }
12791292 SequenceNumber *string `type:"string" required:"true"`
12801293
12811294 // The shard ID of the shard where the data record was placed.
1282 ShardId *string `type:"string" required:"true"`
1295 ShardId *string `min:"1" type:"string" required:"true"`
12831296
12841297 metadataPutRecordOutput `json:"-" xml:"-"`
12851298 }
13011314 // A PutRecords request.
13021315 type PutRecordsInput struct {
13031316 // The records associated with the request.
1304 Records []*PutRecordsRequestEntry `type:"list" required:"true"`
1317 Records []*PutRecordsRequestEntry `min:"1" type:"list" required:"true"`
13051318
13061319 // The stream name associated with the request.
1307 StreamName *string `type:"string" required:"true"`
1320 StreamName *string `min:"1" type:"string" required:"true"`
13081321
13091322 metadataPutRecordsInput `json:"-" xml:"-"`
13101323 }
13261339 // PutRecords results.
13271340 type PutRecordsOutput struct {
13281341 // The number of unsuccessfully processed records in a PutRecords request.
1329 FailedRecordCount *int64 `type:"integer"`
1342 FailedRecordCount *int64 `min:"1" type:"integer"`
13301343
13311344 // An array of successfully and unsuccessfully processed record results, correlated
13321345 // with the request by natural ordering. A record that is successfully added
13331346 // to your Amazon Kinesis stream includes SequenceNumber and ShardId in the
13341347 // result. A record that fails to be added to your Amazon Kinesis stream includes
13351348 // ErrorCode and ErrorMessage in the result.
1336 Records []*PutRecordsResultEntry `type:"list" required:"true"`
1349 Records []*PutRecordsResultEntry `min:"1" type:"list" required:"true"`
13371350
13381351 metadataPutRecordsOutput `json:"-" xml:"-"`
13391352 }
13551368 // Represents the output for PutRecords.
13561369 type PutRecordsRequestEntry struct {
13571370 // The data blob to put into the record, which is base64-encoded when the blob
1358 // is serialized. The maximum size of the data blob (the payload before base64-encoding)
1359 // is 50 kilobytes (KB)
1371 // is serialized. When the data blob (the payload before base64-encoding) is
1372 // added to the partition key size, the total size must not exceed the maximum
1373 // record size (1 MB).
13601374 Data []byte `type:"blob" required:"true"`
13611375
13621376 // The hash value used to determine explicitly the shard that the data record
13711385 // and to map associated data records to shards. As a result of this hashing
13721386 // mechanism, all data records with the same partition key map to the same shard
13731387 // within the stream.
1374 PartitionKey *string `type:"string" required:"true"`
1388 PartitionKey *string `min:"1" type:"string" required:"true"`
13751389
13761390 metadataPutRecordsRequestEntry `json:"-" xml:"-"`
13771391 }
14101424 SequenceNumber *string `type:"string"`
14111425
14121426 // The shard ID for an individual record result.
1413 ShardId *string `type:"string"`
1427 ShardId *string `min:"1" type:"string"`
14141428
14151429 metadataPutRecordsResultEntry `json:"-" xml:"-"`
14161430 }
14321446 // The unit of data of the Amazon Kinesis stream, which is composed of a sequence
14331447 // number, a partition key, and a data blob.
14341448 type Record struct {
1449 // The approximate time that the record was inserted into the stream.
1450 ApproximateArrivalTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
1451
14351452 // The data blob. The data in the blob is both opaque and immutable to the Amazon
14361453 // Kinesis service, which does not inspect, interpret, or change the data in
1437 // the blob in any way. The maximum size of the data blob (the payload before
1438 // base64-encoding) is 50 kilobytes (KB)
1454 // the blob in any way. When the data blob (the payload before base64-encoding)
1455 // is added to the partition key size, the total size must not exceed the maximum
1456 // record size (1 MB).
14391457 Data []byte `type:"blob" required:"true"`
14401458
14411459 // Identifies which shard in the stream the data record is assigned to.
1442 PartitionKey *string `type:"string" required:"true"`
1443
1444 // The unique identifier for the record in the Amazon Kinesis stream.
1460 PartitionKey *string `min:"1" type:"string" required:"true"`
1461
1462 // The unique identifier of the record in the stream.
14451463 SequenceNumber *string `type:"string" required:"true"`
14461464
14471465 metadataRecord `json:"-" xml:"-"`
14641482 // Represents the input for RemoveTagsFromStream.
14651483 type RemoveTagsFromStreamInput struct {
14661484 // The name of the stream.
1467 StreamName *string `type:"string" required:"true"`
1485 StreamName *string `min:"1" type:"string" required:"true"`
14681486
14691487 // A list of tag keys. Each corresponding tag is removed from the stream.
1470 TagKeys []*string `type:"list" required:"true"`
1488 TagKeys []*string `min:"1" type:"list" required:"true"`
14711489
14721490 metadataRemoveTagsFromStreamInput `json:"-" xml:"-"`
14731491 }
15331551 // A uniquely identified group of data records in an Amazon Kinesis stream.
15341552 type Shard struct {
15351553 // The shard Id of the shard adjacent to the shard's parent.
1536 AdjacentParentShardId *string `type:"string"`
1554 AdjacentParentShardId *string `min:"1" type:"string"`
15371555
15381556 // The range of possible hash key values for the shard, which is a set of ordered
15391557 // contiguous positive integers.
15401558 HashKeyRange *HashKeyRange `type:"structure" required:"true"`
15411559
15421560 // The shard Id of the shard's parent.
1543 ParentShardId *string `type:"string"`
1561 ParentShardId *string `min:"1" type:"string"`
15441562
15451563 // The range of possible sequence numbers for the shard.
15461564 SequenceNumberRange *SequenceNumberRange `type:"structure" required:"true"`
15471565
15481566 // The unique identifier of the shard within the Amazon Kinesis stream.
1549 ShardId *string `type:"string" required:"true"`
1567 ShardId *string `min:"1" type:"string" required:"true"`
15501568
15511569 metadataShard `json:"-" xml:"-"`
15521570 }
15771595 NewStartingHashKey *string `type:"string" required:"true"`
15781596
15791597 // The shard ID of the shard to split.
1580 ShardToSplit *string `type:"string" required:"true"`
1598 ShardToSplit *string `min:"1" type:"string" required:"true"`
15811599
15821600 // The name of the stream for the shard split.
1583 StreamName *string `type:"string" required:"true"`
1601 StreamName *string `min:"1" type:"string" required:"true"`
15841602
15851603 metadataSplitShardInput `json:"-" xml:"-"`
15861604 }
16291647 StreamARN *string `type:"string" required:"true"`
16301648
16311649 // The name of the stream being described.
1632 StreamName *string `type:"string" required:"true"`
1650 StreamName *string `min:"1" type:"string" required:"true"`
16331651
16341652 // The current status of the stream being described.
16351653 //
16661684 type Tag struct {
16671685 // A unique identifier for the tag. Maximum length: 128 characters. Valid characters:
16681686 // Unicode letters, digits, white space, _ . / = + - % @
1669 Key *string `type:"string" required:"true"`
1687 Key *string `min:"1" type:"string" required:"true"`
16701688
16711689 // An optional string, typically used to describe or define the tag. Maximum
16721690 // length: 256 characters. Valid characters: Unicode letters, digits, white
+77
-77
service/kms/api.go less more
879879 // Contains information about an alias.
880880 type AliasListEntry struct {
881881 // String that contains the key ARN.
882 AliasArn *string `type:"string"`
882 AliasArn *string `min:"20" type:"string"`
883883
884884 // String that contains the alias.
885 AliasName *string `type:"string"`
885 AliasName *string `min:"1" type:"string"`
886886
887887 // String that contains the key identifier pointed to by the alias.
888 TargetKeyId *string `type:"string"`
888 TargetKeyId *string `min:"1" type:"string"`
889889
890890 metadataAliasListEntry `json:"-" xml:"-"`
891891 }
908908 // String that contains the display name. The name must start with the word
909909 // "alias" followed by a forward slash (alias/). Aliases that begin with "alias/AWS"
910910 // are reserved.
911 AliasName *string `type:"string" required:"true"`
911 AliasName *string `min:"1" type:"string" required:"true"`
912912
913913 // An identifier of the key for which you are creating the alias. This value
914914 // cannot be another alias but can be a globally unique identifier or a fully
915915 // specified ARN to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
916916 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
917 TargetKeyId *string `type:"string" required:"true"`
917 TargetKeyId *string `min:"1" type:"string" required:"true"`
918918
919919 metadataCreateAliasInput `json:"-" xml:"-"`
920920 }
961961
962962 // Principal given permission by the grant to use the key identified by the
963963 // keyId parameter.
964 GranteePrincipal *string `type:"string" required:"true"`
964 GranteePrincipal *string `min:"1" type:"string" required:"true"`
965965
966966 // A unique identifier for the customer master key. This value can be a globally
967967 // unique identifier or the fully specified ARN to a key. Key ARN Example -
968968 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
969969 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
970 KeyId *string `type:"string" required:"true"`
970 KeyId *string `min:"1" type:"string" required:"true"`
971971
972972 // List of operations permitted by the grant. This can be any combination of
973973 // one or more of the following values: Decrypt Encrypt GenerateDataKey GenerateDataKeyWithoutPlaintext
976976
977977 // Principal given permission to retire the grant. For more information, see
978978 // RetireGrant.
979 RetiringPrincipal *string `type:"string"`
979 RetiringPrincipal *string `min:"1" type:"string"`
980980
981981 metadataCreateGrantInput `json:"-" xml:"-"`
982982 }
997997
998998 type CreateGrantOutput struct {
999999 // Unique grant identifier. You can use the GrantId value to revoke a grant.
1000 GrantId *string `type:"string"`
1000 GrantId *string `min:"1" type:"string"`
10011001
10021002 // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token).
1003 GrantToken *string `type:"string"`
1003 GrantToken *string `min:"1" type:"string"`
10041004
10051005 metadataCreateGrantOutput `json:"-" xml:"-"`
10061006 }
10301030
10311031 // Policy to be attached to the key. This is required and delegates back to
10321032 // the account. The key is the root of trust.
1033 Policy *string `type:"string"`
1033 Policy *string `min:"1" type:"string"`
10341034
10351035 metadataCreateKeyInput `json:"-" xml:"-"`
10361036 }
10721072
10731073 type DecryptInput struct {
10741074 // Ciphertext to be decrypted. The blob includes metadata.
1075 CiphertextBlob []byte `type:"blob" required:"true"`
1075 CiphertextBlob []byte `min:"1" type:"blob" required:"true"`
10761076
10771077 // The encryption context. If this was specified in the Encrypt function, it
10781078 // must be specified here or the decryption operation will fail. For more information,
11021102 type DecryptOutput struct {
11031103 // ARN of the key used to perform the decryption. This value is returned if
11041104 // no errors are encountered during the operation.
1105 KeyId *string `type:"string"`
1105 KeyId *string `min:"1" type:"string"`
11061106
11071107 // Decrypted plaintext data. This value may not be returned if the customer
11081108 // master key is not available or if you didn't have permission to use it.
1109 Plaintext []byte `type:"blob"`
1109 Plaintext []byte `min:"1" type:"blob"`
11101110
11111111 metadataDecryptOutput `json:"-" xml:"-"`
11121112 }
11281128 type DeleteAliasInput struct {
11291129 // The alias to be deleted. The name must start with the word "alias" followed
11301130 // by a forward slash (alias/). Aliases that begin with "alias/AWS" are reserved.
1131 AliasName *string `type:"string" required:"true"`
1131 AliasName *string `min:"1" type:"string" required:"true"`
11321132
11331133 metadataDeleteAliasInput `json:"-" xml:"-"`
11341134 }
11721172 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
11731173 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
11741174 // Name Example - alias/MyAliasName
1175 KeyId *string `type:"string" required:"true"`
1175 KeyId *string `min:"1" type:"string" required:"true"`
11761176
11771177 metadataDescribeKeyInput `json:"-" xml:"-"`
11781178 }
12171217 // unique identifier or the fully specified ARN to a key. Key ARN Example -
12181218 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
12191219 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1220 KeyId *string `type:"string" required:"true"`
1220 KeyId *string `min:"1" type:"string" required:"true"`
12211221
12221222 metadataDisableKeyInput `json:"-" xml:"-"`
12231223 }
12591259 // unique identifier or the fully specified ARN to a key. Key ARN Example -
12601260 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
12611261 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1262 KeyId *string `type:"string" required:"true"`
1262 KeyId *string `min:"1" type:"string" required:"true"`
12631263
12641264 metadataDisableKeyRotationInput `json:"-" xml:"-"`
12651265 }
13011301 // unique identifier or the fully specified ARN to a key. Key ARN Example -
13021302 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
13031303 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1304 KeyId *string `type:"string" required:"true"`
1304 KeyId *string `min:"1" type:"string" required:"true"`
13051305
13061306 metadataEnableKeyInput `json:"-" xml:"-"`
13071307 }
13431343 // unique identifier or the fully specified ARN to a key. Key ARN Example -
13441344 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
13451345 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1346 KeyId *string `type:"string" required:"true"`
1346 KeyId *string `min:"1" type:"string" required:"true"`
13471347
13481348 metadataEnableKeyRotationInput `json:"-" xml:"-"`
13491349 }
13961396 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
13971397 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
13981398 // Name Example - alias/MyAliasName
1399 KeyId *string `type:"string" required:"true"`
1399 KeyId *string `min:"1" type:"string" required:"true"`
14001400
14011401 // Data to be encrypted.
1402 Plaintext []byte `type:"blob" required:"true"`
1402 Plaintext []byte `min:"1" type:"blob" required:"true"`
14031403
14041404 metadataEncryptInput `json:"-" xml:"-"`
14051405 }
14211421 type EncryptOutput struct {
14221422 // The encrypted plaintext. If you are using the CLI, the value is Base64 encoded.
14231423 // Otherwise, it is not encoded.
1424 CiphertextBlob []byte `type:"blob"`
1424 CiphertextBlob []byte `min:"1" type:"blob"`
14251425
14261426 // The ID of the key used during encryption.
1427 KeyId *string `type:"string"`
1427 KeyId *string `min:"1" type:"string"`
14281428
14291429 metadataEncryptOutput `json:"-" xml:"-"`
14301430 }
14581458 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
14591459 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
14601460 // Name Example - alias/MyAliasName
1461 KeyId *string `type:"string" required:"true"`
1461 KeyId *string `min:"1" type:"string" required:"true"`
14621462
14631463 // Value that identifies the encryption algorithm and key size to generate a
14641464 // data key for. Currently this can be AES_128 or AES_256.
14671467 // Integer that contains the number of bytes to generate. Common values are
14681468 // 128, 256, 512, and 1024. 1024 is the current limit. We recommend that you
14691469 // use the KeySpec parameter instead.
1470 NumberOfBytes *int64 `type:"integer"`
1470 NumberOfBytes *int64 `min:"1" type:"integer"`
14711471
14721472 metadataGenerateDataKeyInput `json:"-" xml:"-"`
14731473 }
14951495 //
14961496 // If you are using the CLI, the value is Base64 encoded. Otherwise, it is
14971497 // not encoded.
1498 CiphertextBlob []byte `type:"blob"`
1498 CiphertextBlob []byte `min:"1" type:"blob"`
14991499
15001500 // System generated unique identifier of the key to be used to decrypt the encrypted
15011501 // copy of the data key.
1502 KeyId *string `type:"string"`
1502 KeyId *string `min:"1" type:"string"`
15031503
15041504 // Plaintext that contains the data key. Use this for encryption and decryption
15051505 // and then remove it from memory as soon as possible.
1506 Plaintext []byte `type:"blob"`
1506 Plaintext []byte `min:"1" type:"blob"`
15071507
15081508 metadataGenerateDataKeyOutput `json:"-" xml:"-"`
15091509 }
15361536 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
15371537 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
15381538 // Name Example - alias/MyAliasName
1539 KeyId *string `type:"string" required:"true"`
1539 KeyId *string `min:"1" type:"string" required:"true"`
15401540
15411541 // Value that identifies the encryption algorithm and key size. Currently this
15421542 // can be AES_128 or AES_256.
15451545 // Integer that contains the number of bytes to generate. Common values are
15461546 // 128, 256, 512, 1024 and so on. We recommend that you use the KeySpec parameter
15471547 // instead.
1548 NumberOfBytes *int64 `type:"integer"`
1548 NumberOfBytes *int64 `min:"1" type:"integer"`
15491549
15501550 metadataGenerateDataKeyWithoutPlaintextInput `json:"-" xml:"-"`
15511551 }
15701570 //
15711571 // If you are using the CLI, the value is Base64 encoded. Otherwise, it is
15721572 // not encoded.
1573 CiphertextBlob []byte `type:"blob"`
1573 CiphertextBlob []byte `min:"1" type:"blob"`
15741574
15751575 // System generated unique identifier of the key to be used to decrypt the encrypted
15761576 // copy of the data key.
1577 KeyId *string `type:"string"`
1577 KeyId *string `min:"1" type:"string"`
15781578
15791579 metadataGenerateDataKeyWithoutPlaintextOutput `json:"-" xml:"-"`
15801580 }
15961596 type GenerateRandomInput struct {
15971597 // Integer that contains the number of bytes to generate. Common values are
15981598 // 128, 256, 512, 1024 and so on. The current limit is 1024 bytes.
1599 NumberOfBytes *int64 `type:"integer"`
1599 NumberOfBytes *int64 `min:"1" type:"integer"`
16001600
16011601 metadataGenerateRandomInput `json:"-" xml:"-"`
16021602 }
16171617
16181618 type GenerateRandomOutput struct {
16191619 // Plaintext that contains the unpredictable byte string.
1620 Plaintext []byte `type:"blob"`
1620 Plaintext []byte `min:"1" type:"blob"`
16211621
16221622 metadataGenerateRandomOutput `json:"-" xml:"-"`
16231623 }
16411641 // unique identifier or the fully specified ARN to a key. Key ARN Example -
16421642 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
16431643 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1644 KeyId *string `type:"string" required:"true"`
1644 KeyId *string `min:"1" type:"string" required:"true"`
16451645
16461646 // String that contains the name of the policy. Currently, this must be "default".
16471647 // Policy names can be discovered by calling ListKeyPolicies.
1648 PolicyName *string `type:"string" required:"true"`
1648 PolicyName *string `min:"1" type:"string" required:"true"`
16491649
16501650 metadataGetKeyPolicyInput `json:"-" xml:"-"`
16511651 }
16661666
16671667 type GetKeyPolicyOutput struct {
16681668 // A policy document in JSON format.
1669 Policy *string `type:"string"`
1669 Policy *string `min:"1" type:"string"`
16701670
16711671 metadataGetKeyPolicyOutput `json:"-" xml:"-"`
16721672 }
16901690 // unique identifier or the fully specified ARN to a key. Key ARN Example -
16911691 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
16921692 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1693 KeyId *string `type:"string" required:"true"`
1693 KeyId *string `min:"1" type:"string" required:"true"`
16941694
16951695 metadataGetKeyRotationStatusInput `json:"-" xml:"-"`
16961696 }
17631763 Constraints *GrantConstraints `type:"structure"`
17641764
17651765 // Unique grant identifier.
1766 GrantId *string `type:"string"`
1766 GrantId *string `min:"1" type:"string"`
17671767
17681768 // The principal that receives the grant permission.
1769 GranteePrincipal *string `type:"string"`
1769 GranteePrincipal *string `min:"1" type:"string"`
17701770
17711771 // The account under which the grant was issued.
1772 IssuingAccount *string `type:"string"`
1772 IssuingAccount *string `min:"1" type:"string"`
17731773
17741774 // List of operations permitted by the grant. This can be any combination of
17751775 // one or more of the following values: Decrypt Encrypt GenerateDataKey GenerateDataKeyWithoutPlaintext
17771777 Operations []*string `type:"list"`
17781778
17791779 // The principal that can retire the account.
1780 RetiringPrincipal *string `type:"string"`
1780 RetiringPrincipal *string `min:"1" type:"string"`
17811781
17821782 metadataGrantListEntry `json:"-" xml:"-"`
17831783 }
17991799 // Contains information about each entry in the key list.
18001800 type KeyListEntry struct {
18011801 // ARN of the key.
1802 KeyArn *string `type:"string"`
1802 KeyArn *string `min:"20" type:"string"`
18031803
18041804 // Unique identifier of the key.
1805 KeyId *string `type:"string"`
1805 KeyId *string `min:"1" type:"string"`
18061806
18071807 metadataKeyListEntry `json:"-" xml:"-"`
18081808 }
18271827 AWSAccountId *string `type:"string"`
18281828
18291829 // Key ARN (Amazon Resource Name).
1830 Arn *string `type:"string"`
1830 Arn *string `min:"20" type:"string"`
18311831
18321832 // Date the key was created.
18331833 CreationDate *time.Time `type:"timestamp" timestampFormat:"unix"`
18391839 Enabled *bool `type:"boolean"`
18401840
18411841 // Unique identifier for the key.
1842 KeyId *string `type:"string" required:"true"`
1842 KeyId *string `min:"1" type:"string" required:"true"`
18431843
18441844 // A value that specifies what operation(s) the key can perform.
18451845 KeyUsage *string `type:"string" enum:"KeyUsageType"`
18651865 // Specify this parameter when paginating results to indicate the maximum number
18661866 // of aliases you want in each response. If there are additional aliases beyond
18671867 // the maximum you specify, the Truncated response element will be set to true.
1868 Limit *int64 `type:"integer"`
1868 Limit *int64 `min:"1" type:"integer"`
18691869
18701870 // Use this parameter when paginating results, and only in a subsequent request
18711871 // after you've received a response where the results are truncated. Set it
18721872 // to the value of the NextMarker element in the response you just received.
1873 Marker *string `type:"string"`
1873 Marker *string `min:"1" type:"string"`
18741874
18751875 metadataListAliasesInput `json:"-" xml:"-"`
18761876 }
18951895
18961896 // If Truncated is true, this value is present and contains the value to use
18971897 // for the Marker request parameter in a subsequent pagination request.
1898 NextMarker *string `type:"string"`
1898 NextMarker *string `min:"1" type:"string"`
18991899
19001900 // A flag that indicates whether there are more items in the list. If your results
19011901 // were truncated, you can make a subsequent pagination request using the Marker
19241924 // unique identifier or the fully specified ARN to a key. Key ARN Example -
19251925 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
19261926 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
1927 KeyId *string `type:"string" required:"true"`
1927 KeyId *string `min:"1" type:"string" required:"true"`
19281928
19291929 // Specify this parameter only when paginating results to indicate the maximum
19301930 // number of grants you want listed in the response. If there are additional
19311931 // grants beyond the maximum you specify, the Truncated response element will
19321932 // be set to true.
1933 Limit *int64 `type:"integer"`
1933 Limit *int64 `min:"1" type:"integer"`
19341934
19351935 // Use this parameter only when paginating results, and only in a subsequent
19361936 // request after you've received a response where the results are truncated.
19371937 // Set it to the value of the NextMarker in the response you just received.
1938 Marker *string `type:"string"`
1938 Marker *string `min:"1" type:"string"`
19391939
19401940 metadataListGrantsInput `json:"-" xml:"-"`
19411941 }
19601960
19611961 // If Truncated is true, this value is present and contains the value to use
19621962 // for the Marker request parameter in a subsequent pagination request.
1963 NextMarker *string `type:"string"`
1963 NextMarker *string `min:"1" type:"string"`
19641964
19651965 // A flag that indicates whether there are more items in the list. If your results
19661966 // were truncated, you can make a subsequent pagination request using the Marker
19911991 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
19921992 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
19931993 // Name Example - alias/MyAliasName
1994 KeyId *string `type:"string" required:"true"`
1994 KeyId *string `min:"1" type:"string" required:"true"`
19951995
19961996 // Specify this parameter only when paginating results to indicate the maximum
19971997 // number of policies you want listed in the response. If there are additional
19981998 // policies beyond the maximum you specify, the Truncated response element will
19991999 // be set to true.
2000 Limit *int64 `type:"integer"`
2000 Limit *int64 `min:"1" type:"integer"`
20012001
20022002 // Use this parameter only when paginating results, and only in a subsequent
20032003 // request after you've received a response where the results are truncated.
20042004 // Set it to the value of the NextMarker in the response you just received.
2005 Marker *string `type:"string"`
2005 Marker *string `min:"1" type:"string"`
20062006
20072007 metadataListKeyPoliciesInput `json:"-" xml:"-"`
20082008 }
20242024 type ListKeyPoliciesOutput struct {
20252025 // If Truncated is true, this value is present and contains the value to use
20262026 // for the Marker request parameter in a subsequent pagination request.
2027 NextMarker *string `type:"string"`
2027 NextMarker *string `min:"1" type:"string"`
20282028
20292029 // A list of policy names. Currently, there is only one policy and it is named
20302030 // "Default".
20572057 // number of keys you want listed in the response. If there are additional keys
20582058 // beyond the maximum you specify, the Truncated response element will be set
20592059 // to true.
2060 Limit *int64 `type:"integer"`
2060 Limit *int64 `min:"1" type:"integer"`
20612061
20622062 // Use this parameter only when paginating results, and only in a subsequent
20632063 // request after you've received a response where the results are truncated.
20642064 // Set it to the value of the NextMarker in the response you just received.
2065 Marker *string `type:"string"`
2065 Marker *string `min:"1" type:"string"`
20662066
20672067 metadataListKeysInput `json:"-" xml:"-"`
20682068 }
20872087
20882088 // If Truncated is true, this value is present and contains the value to use
20892089 // for the Marker request parameter in a subsequent pagination request.
2090 NextMarker *string `type:"string"`
2090 NextMarker *string `min:"1" type:"string"`
20912091
20922092 // A flag that indicates whether there are more items in the list. If your results
20932093 // were truncated, you can make a subsequent pagination request using the Marker
21162116 // unique identifier or the fully specified ARN to a key. Key ARN Example -
21172117 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
21182118 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
2119 KeyId *string `type:"string" required:"true"`
2119 KeyId *string `min:"1" type:"string" required:"true"`
21202120
21212121 // The policy, in JSON format, to be attached to the key.
2122 Policy *string `type:"string" required:"true"`
2122 Policy *string `min:"1" type:"string" required:"true"`
21232123
21242124 // Name of the policy to be attached. Currently, the only supported name is
21252125 // "default".
2126 PolicyName *string `type:"string" required:"true"`
2126 PolicyName *string `min:"1" type:"string" required:"true"`
21272127
21282128 metadataPutKeyPolicyInput `json:"-" xml:"-"`
21292129 }
21622162
21632163 type ReEncryptInput struct {
21642164 // Ciphertext of the data to re-encrypt.
2165 CiphertextBlob []byte `type:"blob" required:"true"`
2165 CiphertextBlob []byte `min:"1" type:"blob" required:"true"`
21662166
21672167 // Encryption context to be used when the data is re-encrypted.
21682168 DestinationEncryptionContext map[string]*string `type:"map"`
21742174 // Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
21752175 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012 Alias
21762176 // Name Example - alias/MyAliasName
2177 DestinationKeyId *string `type:"string" required:"true"`
2177 DestinationKeyId *string `min:"1" type:"string" required:"true"`
21782178
21792179 // For more information, see Grant Tokens (http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token).
21802180 GrantTokens []*string `type:"list"`
22032203 type ReEncryptOutput struct {
22042204 // The re-encrypted data. If you are using the CLI, the value is Base64 encoded.
22052205 // Otherwise, it is not encoded.
2206 CiphertextBlob []byte `type:"blob"`
2206 CiphertextBlob []byte `min:"1" type:"blob"`
22072207
22082208 // Unique identifier of the key used to re-encrypt the data.
2209 KeyId *string `type:"string"`
2209 KeyId *string `min:"1" type:"string"`
22102210
22112211 // Unique identifier of the key used to originally encrypt the data.
2212 SourceKeyId *string `type:"string"`
2212 SourceKeyId *string `min:"1" type:"string"`
22132213
22142214 metadataReEncryptOutput `json:"-" xml:"-"`
22152215 }
22312231 type RetireGrantInput struct {
22322232 // Unique identifier of the grant to be retired. The grant ID is returned by
22332233 // the CreateGrant function. Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
2234 GrantId *string `type:"string"`
2234 GrantId *string `min:"1" type:"string"`
22352235
22362236 // Token that identifies the grant to be retired.
2237 GrantToken *string `type:"string"`
2237 GrantToken *string `min:"1" type:"string"`
22382238
22392239 // A unique identifier for the customer master key associated with the grant.
22402240 // This value can be a globally unique identifier or a fully specified ARN of
22412241 // the key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
22422242 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
2243 KeyId *string `type:"string"`
2243 KeyId *string `min:"1" type:"string"`
22442244
22452245 metadataRetireGrantInput `json:"-" xml:"-"`
22462246 }
22792279
22802280 type RevokeGrantInput struct {
22812281 // Identifier of the grant to be revoked.
2282 GrantId *string `type:"string" required:"true"`
2282 GrantId *string `min:"1" type:"string" required:"true"`
22832283
22842284 // A unique identifier for the customer master key associated with the grant.
22852285 // This value can be a globally unique identifier or the fully specified ARN
22862286 // to a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
22872287 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
2288 KeyId *string `type:"string" required:"true"`
2288 KeyId *string `min:"1" type:"string" required:"true"`
22892289
22902290 metadataRevokeGrantInput `json:"-" xml:"-"`
22912291 }
23262326 // String that contains the name of the alias to be modifed. The name must start
23272327 // with the word "alias" followed by a forward slash (alias/). Aliases that
23282328 // begin with "alias/AWS" are reserved.
2329 AliasName *string `type:"string" required:"true"`
2329 AliasName *string `min:"1" type:"string" required:"true"`
23302330
23312331 // Unique identifier of the customer master key to be associated with the alias.
23322332 // This value can be a globally unique identifier or the fully specified ARN
23332333 // of a key. Key ARN Example - arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
23342334 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
2335 TargetKeyId *string `type:"string" required:"true"`
2335 TargetKeyId *string `min:"1" type:"string" required:"true"`
23362336
23372337 metadataUpdateAliasInput `json:"-" xml:"-"`
23382338 }
23772377 // unique identifier or the fully specified ARN to a key. Key ARN Example -
23782378 // arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
23792379 // Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
2380 KeyId *string `type:"string" required:"true"`
2380 KeyId *string `min:"1" type:"string" required:"true"`
23812381
23822382 metadataUpdateKeyDescriptionInput `json:"-" xml:"-"`
23832383 }
+34
-34
service/lambda/api.go less more
611611 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
612612 // Note that the length constraint applies only to the ARN. If you specify only
613613 // the function name, it is limited to 64 character in length.
614 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
614 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
615615
616616 // The principal who is getting this permission. It can be Amazon S3 service
617617 // Principal ("s3.amazonaws.com") if you want Amazon S3 to invoke the function,
641641 SourceArn *string `type:"string"`
642642
643643 // A unique statement identifier.
644 StatementId *string `type:"string" required:"true"`
644 StatementId *string `min:"1" type:"string" required:"true"`
645645
646646 metadataAddPermissionInput `json:"-" xml:"-"`
647647 }
686686 // The largest number of records that AWS Lambda will retrieve from your event
687687 // source at the time of invoking your function. Your function receives an event
688688 // with all the retrieved records. The default is 100 records.
689 BatchSize *int64 `type:"integer"`
689 BatchSize *int64 `min:"1" type:"integer"`
690690
691691 // Indicates whether AWS Lambda should begin polling the event source, the default
692692 // is not enabled.
707707 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
708708 // Note that the length constraint applies only to the ARN. If you specify only
709709 // the function name, it is limited to 64 character in length.
710 FunctionName *string `type:"string" required:"true"`
710 FunctionName *string `min:"1" type:"string" required:"true"`
711711
712712 // The position in the stream where AWS Lambda should start reading. For more
713713 // information, go to ShardIteratorType (http://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType)
748748 // 64 character in length. The function names appear in the console and are
749749 // returned in the ListFunctions API. Function names are used to specify functions
750750 // to other AWS Lambda APIs, such as Invoke.
751 FunctionName *string `type:"string" required:"true"`
751 FunctionName *string `min:"1" type:"string" required:"true"`
752752
753753 // The function within your code that Lambda calls to begin execution. For Node.js,
754754 // it is the module-name.export value in your function. For Java, it can be
762762 // a database operation might need less memory compared to an image processing
763763 // function. The default value is 128 MB. The value must be a multiple of 64
764764 // MB.
765 MemorySize *int64 `type:"integer"`
765 MemorySize *int64 `min:"128" type:"integer"`
766766
767767 // The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it
768768 // executes your function to access any other Amazon Web Services (AWS) resources.
776776 // The function execution time at which Lambda should terminate the function.
777777 // Because the execution time has cost implications, we recommend you set this
778778 // value based on your expected execution time. The default is 3 seconds.
779 Timeout *int64 `type:"integer"`
779 Timeout *int64 `min:"1" type:"integer"`
780780
781781 metadataCreateFunctionInput `json:"-" xml:"-"`
782782 }
825825 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
826826 // Note that the length constraint applies only to the ARN. If you specify only
827827 // the function name, it is limited to 64 character in length.
828 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
828 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
829829
830830 metadataDeleteFunctionInput `json:"-" xml:"-"`
831831 }
867867 // The largest number of records that AWS Lambda will retrieve from your event
868868 // source at the time of invoking your function. Your function receives an event
869869 // with all the retrieved records.
870 BatchSize *int64 `type:"integer"`
870 BatchSize *int64 `min:"1" type:"integer"`
871871
872872 // The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source
873873 // of events.
915915 // Amazon S3 bucket name where the .zip file containing your deployment package
916916 // is stored. This bucket must reside in the same AWS region where you are creating
917917 // the Lambda function.
918 S3Bucket *string `type:"string"`
918 S3Bucket *string `min:"3" type:"string"`
919919
920920 // The Amazon S3 object (the deployment package) key name you want to upload.
921 S3Key *string `type:"string"`
921 S3Key *string `min:"1" type:"string"`
922922
923923 // The Amazon S3 object (the deployment package) version you want to upload.
924 S3ObjectVersion *string `type:"string"`
924 S3ObjectVersion *string `min:"1" type:"string"`
925925
926926 // A base64-encoded .zip file containing your deployment package. For more information
927927 // about creating a .zip file, go to Execution Permissions (http://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html#lambda-intro-execution-role.html)
983983 FunctionArn *string `type:"string"`
984984
985985 // The name of the function.
986 FunctionName *string `type:"string"`
986 FunctionName *string `min:"1" type:"string"`
987987
988988 // The function Lambda calls to begin executing your function.
989989 Handler *string `type:"string"`
993993
994994 // The memory size, in MB, you configured for the function. Must be a multiple
995995 // of 64 MB.
996 MemorySize *int64 `type:"integer"`
996 MemorySize *int64 `min:"128" type:"integer"`
997997
998998 // The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it
999999 // executes your function to access any other Amazon Web Services (AWS) resources.
10051005 // The function execution time at which Lambda should terminate the function.
10061006 // Because the execution time has cost implications, we recommend you set this
10071007 // value based on your expected execution time. The default is 3 seconds.
1008 Timeout *int64 `type:"integer"`
1008 Timeout *int64 `min:"1" type:"integer"`
10091009
10101010 metadataFunctionConfiguration `json:"-" xml:"-"`
10111011 }
10551055 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
10561056 // Note that the length constraint applies only to the ARN. If you specify only
10571057 // the function name, it is limited to 64 character in length.
1058 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1058 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
10591059
10601060 metadataGetFunctionConfigurationInput `json:"-" xml:"-"`
10611061 }
10831083 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
10841084 // Note that the length constraint applies only to the ARN. If you specify only
10851085 // the function name, it is limited to 64 character in length.
1086 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1086 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
10871087
10881088 metadataGetFunctionInput `json:"-" xml:"-"`
10891089 }
11361136 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
11371137 // Note that the length constraint applies only to the ARN. If you specify only
11381138 // the function name, it is limited to 64 character in length.
1139 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1139 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
11401140
11411141 metadataGetPolicyInput `json:"-" xml:"-"`
11421142 }
11791179
11801180 type InvokeAsyncInput struct {
11811181 // The Lambda function name.
1182 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1182 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
11831183
11841184 // JSON that you want to provide to your Lambda function as input.
11851185 InvokeArgs io.ReadSeeker `type:"blob" required:"true"`
12411241 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
12421242 // Note that the length constraint applies only to the ARN. If you specify only
12431243 // the function name, it is limited to 64 character in length.
1244 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1244 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
12451245
12461246 // By default, the Invoke API assumes "RequestResponse" invocation type. You
12471247 // can optionally request asynchronous execution by specifying "Event" as the
13361336 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
13371337 // Note that the length constraint applies only to the ARN. If you specify only
13381338 // the function name, it is limited to 64 character in length.
1339 FunctionName *string `location:"querystring" locationName:"FunctionName" type:"string"`
1339 FunctionName *string `location:"querystring" locationName:"FunctionName" min:"1" type:"string"`
13401340
13411341 // Optional string. An opaque pagination token returned from a previous ListEventSourceMappings
13421342 // operation. If present, specifies to continue the list from where the returning
13451345
13461346 // Optional integer. Specifies the maximum number of event sources to return
13471347 // in response. This value must be greater than 0.
1348 MaxItems *int64 `location:"querystring" locationName:"MaxItems" type:"integer"`
1348 MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
13491349
13501350 metadataListEventSourceMappingsInput `json:"-" xml:"-"`
13511351 }
13961396
13971397 // Optional integer. Specifies the maximum number of AWS Lambda functions to
13981398 // return in response. This parameter value must be greater than 0.
1399 MaxItems *int64 `location:"querystring" locationName:"MaxItems" type:"integer"`
1399 MaxItems *int64 `location:"querystring" locationName:"MaxItems" min:"1" type:"integer"`
14001400
14011401 metadataListFunctionsInput `json:"-" xml:"-"`
14021402 }
14491449 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
14501450 // Note that the length constraint applies only to the ARN. If you specify only
14511451 // the function name, it is limited to 64 character in length.
1452 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1452 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
14531453
14541454 // Statement ID of the permission to remove.
1455 StatementId *string `location:"uri" locationName:"StatementId" type:"string" required:"true"`
1455 StatementId *string `location:"uri" locationName:"StatementId" min:"1" type:"string" required:"true"`
14561456
14571457 metadataRemovePermissionInput `json:"-" xml:"-"`
14581458 }
14921492 type UpdateEventSourceMappingInput struct {
14931493 // The maximum number of stream records that can be sent to your Lambda function
14941494 // for a single invocation.
1495 BatchSize *int64 `type:"integer"`
1495 BatchSize *int64 `min:"1" type:"integer"`
14961496
14971497 // Specifies whether AWS Lambda should actively poll the stream or not. If disabled,
14981498 // AWS Lambda will not poll the stream.
15061506 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
15071507 // Note that the length constraint applies only to the ARN. If you specify only
15081508 // the function name, it is limited to 64 character in length.
1509 FunctionName *string `type:"string"`
1509 FunctionName *string `min:"1" type:"string"`
15101510
15111511 // The event source mapping identifier.
15121512 UUID *string `location:"uri" locationName:"UUID" type:"string" required:"true"`
15371537 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
15381538 // Note that the length constraint applies only to the ARN. If you specify only
15391539 // the function name, it is limited to 64 character in length.
1540 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1540 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
15411541
15421542 // Amazon S3 bucket name where the .zip file containing your deployment package
15431543 // is stored. This bucket must reside in the same AWS region where you are creating
15441544 // the Lambda function.
1545 S3Bucket *string `type:"string"`
1545 S3Bucket *string `min:"3" type:"string"`
15461546
15471547 // The Amazon S3 object (the deployment package) key name you want to upload.
1548 S3Key *string `type:"string"`
1548 S3Key *string `min:"1" type:"string"`
15491549
15501550 // The Amazon S3 object (the deployment package) version you want to upload.
1551 S3ObjectVersion *string `type:"string"`
1551 S3ObjectVersion *string `min:"1" type:"string"`
15521552
15531553 // Based64-encoded .zip file containing your packaged source code.
15541554 ZipFile []byte `type:"blob"`
15831583 // allows you to specify only the account ID qualifier (for example, "account-id:Thumbnail").
15841584 // Note that the length constraint applies only to the ARN. If you specify only
15851585 // the function name, it is limited to 64 character in length.
1586 FunctionName *string `location:"uri" locationName:"FunctionName" type:"string" required:"true"`
1586 FunctionName *string `location:"uri" locationName:"FunctionName" min:"1" type:"string" required:"true"`
15871587
15881588 // The function that Lambda calls to begin executing your function. For Node.js,
15891589 // it is the module-name.export value in your function.
15951595 // a database operation might need less memory compared to an image processing
15961596 // function. The default value is 128 MB. The value must be a multiple of 64
15971597 // MB.
1598 MemorySize *int64 `type:"integer"`
1598 MemorySize *int64 `min:"128" type:"integer"`
15991599
16001600 // The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when
16011601 // it executes your function.
16041604 // The function execution time at which AWS Lambda should terminate the function.
16051605 // Because the execution time has cost implications, we recommend you set this
16061606 // value based on your expected execution time. The default is 3 seconds.
1607 Timeout *int64 `type:"integer"`
1607 Timeout *int64 `min:"1" type:"integer"`
16081608
16091609 metadataUpdateFunctionConfigurationInput `json:"-" xml:"-"`
16101610 }
+195
-105
service/machinelearning/api.go less more
340340 // After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction
341341 // operation to verify that the status of the BatchPrediction changed to DELETED.
342342 //
343 // Caution The result of the DeleteBatchPrediction operation is irreversible.
343 // Caution: The result of the DeleteBatchPrediction operation is irreversible.
344344 func (c *MachineLearning) DeleteBatchPrediction(input *DeleteBatchPredictionInput) (*DeleteBatchPredictionOutput, error) {
345345 req, out := c.DeleteBatchPredictionRequest(input)
346346 err := req.Send()
372372 // After using the DeleteDataSource operation, you can use the GetDataSource
373373 // operation to verify that the status of the DataSource changed to DELETED.
374374 //
375 // Caution The results of the DeleteDataSource operation are irreversible.
375 // Caution: The results of the DeleteDataSource operation are irreversible.
376376 func (c *MachineLearning) DeleteDataSource(input *DeleteDataSourceInput) (*DeleteDataSourceOutput, error) {
377377 req, out := c.DeleteDataSourceRequest(input)
378378 err := req.Send()
404404 // After invoking the DeleteEvaluation operation, you can use the GetEvaluation
405405 // operation to verify that the status of the Evaluation changed to DELETED.
406406 //
407 // Caution The results of the DeleteEvaluation operation are irreversible.
407 // Caution: The results of the DeleteEvaluation operation are irreversible.
408408 func (c *MachineLearning) DeleteEvaluation(input *DeleteEvaluationInput) (*DeleteEvaluationOutput, error) {
409409 req, out := c.DeleteEvaluationRequest(input)
410410 err := req.Send()
436436 // After using the DeleteMLModel operation, you can use the GetMLModel operation
437437 // to verify that the status of the MLModel changed to DELETED.
438438 //
439 // Caution The result of the DeleteMLModel operation is irreversible.
439 // Caution: The result of the DeleteMLModel operation is irreversible.
440440 func (c *MachineLearning) DeleteMLModel(input *DeleteMLModelInput) (*DeleteMLModelOutput, error) {
441441 req, out := c.DeleteMLModelRequest(input)
442442 err := req.Send()
770770 return
771771 }
772772
773 // Generates a prediction for the observation using the specified MLModel.
774 //
775 // Note Not all response parameters will be populated because this is dependent
776 // on the type of requested model.
773 // Generates a prediction for the observation using the specified ML Model.
774 //
775 // Note Not all response parameters will be populated. Whether a response parameter
776 // is populated depends on the type of model requested.
777777 func (c *MachineLearning) Predict(input *PredictInput) (*PredictOutput, error) {
778778 req, out := c.PredictRequest(input)
779779 err := req.Send()
906906 // file information of a Batch Prediction.
907907 type BatchPrediction struct {
908908 // The ID of the DataSource that points to the group of observations to predict.
909 BatchPredictionDataSourceId *string `type:"string"`
909 BatchPredictionDataSourceId *string `min:"1" type:"string"`
910910
911911 // The ID assigned to the BatchPrediction at creation. This value should be
912912 // identical to the value of the BatchPredictionID in the request.
913 BatchPredictionId *string `type:"string"`
913 BatchPredictionId *string `min:"1" type:"string"`
914914
915915 // The time that the BatchPrediction was created. The time is expressed in epoch
916916 // time.
931931
932932 // The ID of the MLModel that generated predictions for the BatchPrediction
933933 // request.
934 MLModelId *string `type:"string"`
934 MLModelId *string `min:"1" type:"string"`
935935
936936 // A description of the most recent details about processing the batch prediction
937937 // request.
974974
975975 type CreateBatchPredictionInput struct {
976976 // The ID of the DataSource that points to the group of observations to predict.
977 BatchPredictionDataSourceId *string `type:"string" required:"true"`
977 BatchPredictionDataSourceId *string `min:"1" type:"string" required:"true"`
978978
979979 // A user-supplied ID that uniquely identifies the BatchPrediction.
980 BatchPredictionId *string `type:"string" required:"true"`
980 BatchPredictionId *string `min:"1" type:"string" required:"true"`
981981
982982 // A user-supplied name or description of the BatchPrediction. BatchPredictionName
983983 // can only use the UTF-8 character set.
984984 BatchPredictionName *string `type:"string"`
985985
986986 // The ID of the MLModel that will generate predictions for the group of observations.
987 MLModelId *string `type:"string" required:"true"`
987 MLModelId *string `min:"1" type:"string" required:"true"`
988988
989989 // The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory
990990 // to store the batch prediction results. The following substrings are not allowed
10211021 type CreateBatchPredictionOutput struct {
10221022 // A user-supplied ID that uniquely identifies the BatchPrediction. This value
10231023 // is identical to the value of the BatchPredictionId in the request.
1024 BatchPredictionId *string `type:"string"`
1024 BatchPredictionId *string `min:"1" type:"string"`
10251025
10261026 metadataCreateBatchPredictionOutput `json:"-" xml:"-"`
10271027 }
10491049
10501050 // A user-supplied ID that uniquely identifies the DataSource. Typically, an
10511051 // Amazon Resource Number (ARN) becomes the ID for a DataSource.
1052 DataSourceId *string `type:"string" required:"true"`
1052 DataSourceId *string `min:"1" type:"string" required:"true"`
10531053
10541054 // A user-supplied name or description of the DataSource.
10551055 DataSourceName *string `type:"string"`
10921092 // DataRearrangement - A JSON string representing the splitting requirement
10931093 // of a Datasource.
10941094 //
1095 // Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
1095 // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
10961096 RDSData *RDSDataSpec `type:"structure" required:"true"`
10971097
10981098 // The role that Amazon ML assumes on behalf of the user to create and activate
10991099 // a data pipeline in the user’s account and copy data (using the SelectSqlQuery)
11001100 // query from Amazon RDS to Amazon S3.
1101 RoleARN *string `type:"string" required:"true"`
1101 RoleARN *string `min:"1" type:"string" required:"true"`
11021102
11031103 metadataCreateDataSourceFromRDSInput `json:"-" xml:"-"`
11041104 }
11291129 type CreateDataSourceFromRDSOutput struct {
11301130 // A user-supplied ID that uniquely identifies the datasource. This value should
11311131 // be identical to the value of the DataSourceID in the request.
1132 DataSourceId *string `type:"string"`
1132 DataSourceId *string `min:"1" type:"string"`
11331133
11341134 metadataCreateDataSourceFromRDSOutput `json:"-" xml:"-"`
11351135 }
11561156 ComputeStatistics *bool `type:"boolean"`
11571157
11581158 // A user-supplied ID that uniquely identifies the DataSource.
1159 DataSourceId *string `type:"string" required:"true"`
1159 DataSourceId *string `min:"1" type:"string" required:"true"`
11601160
11611161 // A user-supplied name or description of the DataSource.
11621162 DataSourceName *string `type:"string"`
11841184 // DataRearrangement - A JSON string representing the splitting requirement
11851185 // of a Datasource.
11861186 //
1187 // Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
1187 // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
11881188 DataSpec *RedshiftDataSpec `type:"structure" required:"true"`
11891189
11901190 // A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the
11951195 //
11961196 // An Amazon S3 bucket policy to grant Amazon ML read/write permissions on
11971197 // the S3StagingLocation
1198 RoleARN *string `type:"string" required:"true"`
1198 RoleARN *string `min:"1" type:"string" required:"true"`
11991199
12001200 metadataCreateDataSourceFromRedshiftInput `json:"-" xml:"-"`
12011201 }
12231223 type CreateDataSourceFromRedshiftOutput struct {
12241224 // A user-supplied ID that uniquely identifies the datasource. This value should
12251225 // be identical to the value of the DataSourceID in the request.
1226 DataSourceId *string `type:"string"`
1226 DataSourceId *string `min:"1" type:"string"`
12271227
12281228 metadataCreateDataSourceFromRedshiftOutput `json:"-" xml:"-"`
12291229 }
12501250 ComputeStatistics *bool `type:"boolean"`
12511251
12521252 // A user-supplied identifier that uniquely identifies the DataSource.
1253 DataSourceId *string `type:"string" required:"true"`
1253 DataSourceId *string `min:"1" type:"string" required:"true"`
12541254
12551255 // A user-supplied name or description of the DataSource.
12561256 DataSourceName *string `type:"string"`
12681268 // DataRearrangement - A JSON string representing the splitting requirement
12691269 // of a Datasource.
12701270 //
1271 // Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
1271 // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
12721272 DataSpec *S3DataSpec `type:"structure" required:"true"`
12731273
12741274 metadataCreateDataSourceFromS3Input `json:"-" xml:"-"`
12961296 type CreateDataSourceFromS3Output struct {
12971297 // A user-supplied ID that uniquely identifies the datasource. This value should
12981298 // be identical to the value of the DataSourceID in the request.
1299 DataSourceId *string `type:"string"`
1299 DataSourceId *string `min:"1" type:"string"`
13001300
13011301 metadataCreateDataSourceFromS3Output `json:"-" xml:"-"`
13021302 }
13181318 type CreateEvaluationInput struct {
13191319 // The ID of the DataSource for the evaluation. The schema of the DataSource
13201320 // must match the schema used to create the MLModel.
1321 EvaluationDataSourceId *string `type:"string" required:"true"`
1321 EvaluationDataSourceId *string `min:"1" type:"string" required:"true"`
13221322
13231323 // A user-supplied ID that uniquely identifies the Evaluation.
1324 EvaluationId *string `type:"string" required:"true"`
1324 EvaluationId *string `min:"1" type:"string" required:"true"`
13251325
13261326 // A user-supplied name or description of the Evaluation.
13271327 EvaluationName *string `type:"string"`
13301330 //
13311331 // The schema used in creating the MLModel must match the schema of the DataSource
13321332 // used in the Evaluation.
1333 MLModelId *string `type:"string" required:"true"`
1333 MLModelId *string `min:"1" type:"string" required:"true"`
13341334
13351335 metadataCreateEvaluationInput `json:"-" xml:"-"`
13361336 }
13571357 type CreateEvaluationOutput struct {
13581358 // The user-supplied ID that uniquely identifies the Evaluation. This value
13591359 // should be identical to the value of the EvaluationId in the request.
1360 EvaluationId *string `type:"string"`
1360 EvaluationId *string `min:"1" type:"string"`
13611361
13621362 metadataCreateEvaluationOutput `json:"-" xml:"-"`
13631363 }
13781378
13791379 type CreateMLModelInput struct {
13801380 // A user-supplied ID that uniquely identifies the MLModel.
1381 MLModelId *string `type:"string" required:"true"`
1381 MLModelId *string `min:"1" type:"string" required:"true"`
13821382
13831383 // A user-supplied name or description of the MLModel.
13841384 MLModelName *string `type:"string"`
14371437 RecipeUri *string `type:"string"`
14381438
14391439 // The DataSource that points to the training data.
1440 TrainingDataSourceId *string `type:"string" required:"true"`
1440 TrainingDataSourceId *string `min:"1" type:"string" required:"true"`
14411441
14421442 metadataCreateMLModelInput `json:"-" xml:"-"`
14431443 }
14641464 type CreateMLModelOutput struct {
14651465 // A user-supplied ID that uniquely identifies the MLModel. This value should
14661466 // be identical to the value of the MLModelId in the request.
1467 MLModelId *string `type:"string"`
1467 MLModelId *string `min:"1" type:"string"`
14681468
14691469 metadataCreateMLModelOutput `json:"-" xml:"-"`
14701470 }
14851485
14861486 type CreateRealtimeEndpointInput struct {
14871487 // The ID assigned to the MLModel during creation.
1488 MLModelId *string `type:"string" required:"true"`
1488 MLModelId *string `min:"1" type:"string" required:"true"`
14891489
14901490 metadataCreateRealtimeEndpointInput `json:"-" xml:"-"`
14911491 }
15131513 type CreateRealtimeEndpointOutput struct {
15141514 // A user-supplied ID that uniquely identifies the MLModel. This value should
15151515 // be identical to the value of the MLModelId in the request.
1516 MLModelId *string `type:"string"`
1516 MLModelId *string `min:"1" type:"string"`
15171517
15181518 // The endpoint information of the MLModel
15191519 RealtimeEndpointInfo *RealtimeEndpointInfo `type:"structure"`
15651565 DataSizeInBytes *int64 `type:"long"`
15661566
15671567 // The ID that is assigned to the DataSource during creation.
1568 DataSourceId *string `type:"string"`
1568 DataSourceId *string `min:"1" type:"string"`
15691569
15701570 // The time of the most recent edit to the BatchPrediction. The time is expressed
15711571 // in epoch time.
15881588
15891589 // The Amazon Resource Name (ARN) of an AWS IAM Role (http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts)
15901590 // such as the following: arn:aws:iam::account:role/rolename.
1591 RoleARN *string `type:"string"`
1591 RoleARN *string `min:"1" type:"string"`
15921592
15931593 // The current status of the DataSource. This element can have one of the following
15941594 // values:
16191619
16201620 type DeleteBatchPredictionInput struct {
16211621 // A user-supplied ID that uniquely identifies the BatchPrediction.
1622 BatchPredictionId *string `type:"string" required:"true"`
1622 BatchPredictionId *string `min:"1" type:"string" required:"true"`
16231623
16241624 metadataDeleteBatchPredictionInput `json:"-" xml:"-"`
16251625 }
16451645 type DeleteBatchPredictionOutput struct {
16461646 // A user-supplied ID that uniquely identifies the BatchPrediction. This value
16471647 // should be identical to the value of the BatchPredictionID in the request.
1648 BatchPredictionId *string `type:"string"`
1648 BatchPredictionId *string `min:"1" type:"string"`
16491649
16501650 metadataDeleteBatchPredictionOutput `json:"-" xml:"-"`
16511651 }
16661666
16671667 type DeleteDataSourceInput struct {
16681668 // A user-supplied ID that uniquely identifies the DataSource.
1669 DataSourceId *string `type:"string" required:"true"`
1669 DataSourceId *string `min:"1" type:"string" required:"true"`
16701670
16711671 metadataDeleteDataSourceInput `json:"-" xml:"-"`
16721672 }
16891689 type DeleteDataSourceOutput struct {
16901690 // A user-supplied ID that uniquely identifies the DataSource. This value should
16911691 // be identical to the value of the DataSourceID in the request.
1692 DataSourceId *string `type:"string"`
1692 DataSourceId *string `min:"1" type:"string"`
16931693
16941694 metadataDeleteDataSourceOutput `json:"-" xml:"-"`
16951695 }
17101710
17111711 type DeleteEvaluationInput struct {
17121712 // A user-supplied ID that uniquely identifies the Evaluation to delete.
1713 EvaluationId *string `type:"string" required:"true"`
1713 EvaluationId *string `min:"1" type:"string" required:"true"`
17141714
17151715 metadataDeleteEvaluationInput `json:"-" xml:"-"`
17161716 }
17371737 type DeleteEvaluationOutput struct {
17381738 // A user-supplied ID that uniquely identifies the Evaluation. This value should
17391739 // be identical to the value of the EvaluationId in the request.
1740 EvaluationId *string `type:"string"`
1740 EvaluationId *string `min:"1" type:"string"`
17411741
17421742 metadataDeleteEvaluationOutput `json:"-" xml:"-"`
17431743 }
17581758
17591759 type DeleteMLModelInput struct {
17601760 // A user-supplied ID that uniquely identifies the MLModel.
1761 MLModelId *string `type:"string" required:"true"`
1761 MLModelId *string `min:"1" type:"string" required:"true"`
17621762
17631763 metadataDeleteMLModelInput `json:"-" xml:"-"`
17641764 }
17841784 type DeleteMLModelOutput struct {
17851785 // A user-supplied ID that uniquely identifies the MLModel. This value should
17861786 // be identical to the value of the MLModelID in the request.
1787 MLModelId *string `type:"string"`
1787 MLModelId *string `min:"1" type:"string"`
17881788
17891789 metadataDeleteMLModelOutput `json:"-" xml:"-"`
17901790 }
18051805
18061806 type DeleteRealtimeEndpointInput struct {
18071807 // The ID assigned to the MLModel during creation.
1808 MLModelId *string `type:"string" required:"true"`
1808 MLModelId *string `min:"1" type:"string" required:"true"`
18091809
18101810 metadataDeleteRealtimeEndpointInput `json:"-" xml:"-"`
18111811 }
18301830 type DeleteRealtimeEndpointOutput struct {
18311831 // A user-supplied ID that uniquely identifies the MLModel. This value should
18321832 // be identical to the value of the MLModelId in the request.
1833 MLModelId *string `type:"string"`
1833 MLModelId *string `min:"1" type:"string"`
18341834
18351835 // The endpoint information of the MLModel
18361836 RealtimeEndpointInfo *RealtimeEndpointInfo `type:"structure"`
18901890
18911891 // The number of pages of information to include in the result. The range of
18921892 // acceptable values is 1 through 100. The default value is 100.
1893 Limit *int64 `type:"integer"`
1893 Limit *int64 `min:"1" type:"integer"`
18941894
18951895 // The not equal to operator. The BatchPrediction results will have FilterVariable
18961896 // values not equal to the value specified with NE.
19961996 LT *string `type:"string"`
19971997
19981998 // The maximum number of DataSource to include in the result.
1999 Limit *int64 `type:"integer"`
1999 Limit *int64 `min:"1" type:"integer"`
20002000
20012001 // The not equal to operator. The DataSource results will have FilterVariable
20022002 // values not equal to the value specified with NE.
21042104 LT *string `type:"string"`
21052105
21062106 // The maximum number of Evaluation to include in the result.
2107 Limit *int64 `type:"integer"`
2107 Limit *int64 `min:"1" type:"integer"`
21082108
21092109 // The not equal to operator. The Evaluation results will have FilterVariable
21102110 // values not equal to the value specified with NE.
22152215
22162216 // The number of pages of information to include in the result. The range of
22172217 // acceptable values is 1 through 100. The default value is 100.
2218 Limit *int64 `type:"integer"`
2218 Limit *int64 `min:"1" type:"integer"`
22192219
22202220 // The not equal to operator. The MLModel results will have FilterVariable values
22212221 // not equal to the value specified with NE.
23032303 CreatedByIamUser *string `type:"string"`
23042304
23052305 // The ID of the DataSource that is used to evaluate the MLModel.
2306 EvaluationDataSourceId *string `type:"string"`
2306 EvaluationDataSourceId *string `min:"1" type:"string"`
23072307
23082308 // The ID that is assigned to the Evaluation at creation.
2309 EvaluationId *string `type:"string"`
2309 EvaluationId *string `min:"1" type:"string"`
23102310
23112311 // The location and name of the data in Amazon Simple Storage Server (Amazon
23122312 // S3) that is used in the evaluation.
23172317 LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`
23182318
23192319 // The ID of the MLModel that is the focus of the evaluation.
2320 MLModelId *string `type:"string"`
2320 MLModelId *string `min:"1" type:"string"`
23212321
23222322 // A description of the most recent details about evaluating the MLModel.
23232323 Message *string `type:"string"`
23722372
23732373 type GetBatchPredictionInput struct {
23742374 // An ID assigned to the BatchPrediction at creation.
2375 BatchPredictionId *string `type:"string" required:"true"`
2375 BatchPredictionId *string `min:"1" type:"string" required:"true"`
23762376
23772377 metadataGetBatchPredictionInput `json:"-" xml:"-"`
23782378 }
23942394 // Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.
23952395 type GetBatchPredictionOutput struct {
23962396 // The ID of the DataSource that was used to create the BatchPrediction.
2397 BatchPredictionDataSourceId *string `type:"string"`
2397 BatchPredictionDataSourceId *string `min:"1" type:"string"`
23982398
23992399 // An ID assigned to the BatchPrediction at creation. This value should be identical
24002400 // to the value of the BatchPredictionID in the request.
2401 BatchPredictionId *string `type:"string"`
2401 BatchPredictionId *string `min:"1" type:"string"`
24022402
24032403 // The time when the BatchPrediction was created. The time is expressed in epoch
24042404 // time.
24222422
24232423 // The ID of the MLModel that generated predictions for the BatchPrediction
24242424 // request.
2425 MLModelId *string `type:"string"`
2425 MLModelId *string `min:"1" type:"string"`
24262426
24272427 // A description of the most recent details about processing the batch prediction
24282428 // request.
24632463
24642464 type GetDataSourceInput struct {
24652465 // The ID assigned to the DataSource at creation.
2466 DataSourceId *string `type:"string" required:"true"`
2466 DataSourceId *string `min:"1" type:"string" required:"true"`
24672467
24682468 // Specifies whether the GetDataSource operation should return DataSourceSchema.
24692469 //
25172517
25182518 // The ID assigned to the DataSource at creation. This value should be identical
25192519 // to the value of the DataSourceId in the request.
2520 DataSourceId *string `type:"string"`
2520 DataSourceId *string `min:"1" type:"string"`
25212521
25222522 // The schema used by all of the data files of this DataSource.
25232523 //
25482548
25492549 // The Amazon Resource Name (ARN) of an AWS IAM Role (http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts)
25502550 // such as the following: arn:aws:iam::account:role/rolename.
2551 RoleARN *string `type:"string"`
2551 RoleARN *string `min:"1" type:"string"`
25522552
25532553 // The current status of the DataSource. This element can have one of the following
25542554 // values:
25802580 type GetEvaluationInput struct {
25812581 // The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded
25822582 // and cataloged. The ID provides the means to access the information.
2583 EvaluationId *string `type:"string" required:"true"`
2583 EvaluationId *string `min:"1" type:"string" required:"true"`
25842584
25852585 metadataGetEvaluationInput `json:"-" xml:"-"`
25862586 }
26112611 CreatedByIamUser *string `type:"string"`
26122612
26132613 // The DataSource used for this evaluation.
2614 EvaluationDataSourceId *string `type:"string"`
2614 EvaluationDataSourceId *string `min:"1" type:"string"`
26152615
26162616 // The evaluation ID which is same as the EvaluationId in the request.
2617 EvaluationId *string `type:"string"`
2617 EvaluationId *string `min:"1" type:"string"`
26182618
26192619 // The location of the data file or directory in Amazon Simple Storage Service
26202620 // (Amazon S3).
26282628 LogUri *string `type:"string"`
26292629
26302630 // The ID of the MLModel that was the focus of the evaluation.
2631 MLModelId *string `type:"string"`
2631 MLModelId *string `min:"1" type:"string"`
26322632
26332633 // A description of the most recent details about evaluating the MLModel.
26342634 Message *string `type:"string"`
26832683
26842684 type GetMLModelInput struct {
26852685 // The ID assigned to the MLModel at creation.
2686 MLModelId *string `type:"string" required:"true"`
2686 MLModelId *string `min:"1" type:"string" required:"true"`
26872687
26882688 // Specifies whether the GetMLModel operation should return Recipe.
26892689 //
27352735 LogUri *string `type:"string"`
27362736
27372737 // The MLModel ID which is same as the MLModelId in the request.
2738 MLModelId *string `type:"string"`
2738 MLModelId *string `min:"1" type:"string"`
27392739
27402740 // Identifies the MLModel category. The following are the available types:
27412741 //
27882788 Status *string `type:"string" enum:"EntityStatus"`
27892789
27902790 // The ID of the training DataSource.
2791 TrainingDataSourceId *string `type:"string"`
2791 TrainingDataSourceId *string `min:"1" type:"string"`
27922792
27932793 // A list of the training parameters in the MLModel. The list is implemented
27942794 // as a map of key/value pairs.
28722872 LastUpdatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`
28732873
28742874 // The ID assigned to the MLModel at creation.
2875 MLModelId *string `type:"string"`
2875 MLModelId *string `min:"1" type:"string"`
28762876
28772877 // Identifies the MLModel category. The following are the available types:
28782878 //
29092909 Status *string `type:"string" enum:"EntityStatus"`
29102910
29112911 // The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.
2912 TrainingDataSourceId *string `type:"string"`
2912 TrainingDataSourceId *string `min:"1" type:"string"`
29132913
29142914 // A list of the training parameters in the MLModel. The list is implemented
29152915 // as a map of key/value pairs.
29992999
30003000 type PredictInput struct {
30013001 // A unique identifier of the MLModel.
3002 MLModelId *string `type:"string" required:"true"`
3002 MLModelId *string `min:"1" type:"string" required:"true"`
30033003
30043004 PredictEndpoint *string `type:"string" required:"true"`
30053005
30703070 Details map[string]*string `locationName:"details" type:"map"`
30713071
30723072 // The prediction label for either a BINARY or MULTICLASS MLModel.
3073 PredictedLabel *string `locationName:"predictedLabel" type:"string"`
3073 PredictedLabel *string `locationName:"predictedLabel" min:"1" type:"string"`
30743074
30753075 // Provides the raw classification score corresponding to each label.
30763076 PredictedScores map[string]*float64 `locationName:"predictedScores" type:"map"`
31013101 // DataRearrangement - A JSON string that represents the splitting requirement
31023102 // of a DataSource.
31033103 //
3104 // Sample - "{\"randomSeed\":\"some-random-seed\", \"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
3104 // Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
31053105 DataRearrangement *string `type:"string"`
31063106
3107 // A JSON string that represents the schema. This is not required if DataSchemaUri
3108 // is specified.
3107 // A JSON string that represents the schema for an Amazon RDS DataSource. The
3108 // DataSchema defines the structure of the observation data in the data file(s)
3109 // referenced in the DataSource.
3110 //
3111 // A DataSchema is not required if you specify a DataSchemaUri
3112 //
3113 // Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames
3114 // have an array of key-value pairs for their value. Use the following format
3115 // to define your DataSchema.
3116 //
3117 // { "version": "1.0",
3118 //
3119 // "recordAnnotationFieldName": "F1",
3120 //
3121 // "recordWeightFieldName": "F2",
3122 //
3123 // "targetFieldName": "F3",
3124 //
3125 // "dataFormat": "CSV",
3126 //
3127 // "dataFileContainsHeader": true,
3128 //
3129 // "attributes": [
3130 //
3131 // { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType":
3132 // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName":
3133 // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL"
3134 // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
3135 // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE"
3136 // } ],
3137 //
3138 // "excludedVariableNames": [ "F6" ] }
31093139 DataSchema *string `type:"string"`
31103140
31113141 // The Amazon S3 location of the DataSchema.
31223152 // Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS
31233153 // to an Amazon S3 task. For more information, see Role templates (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html)
31243154 // for data pipelines.
3125 ResourceRole *string `type:"string" required:"true"`
3155 ResourceRole *string `min:"1" type:"string" required:"true"`
31263156
31273157 // The Amazon S3 location for staging Amazon RDS data. The data retrieved from
31283158 // Amazon RDS using SelectSqlQuery is stored in this location.
31353165 SecurityGroupIds []*string `type:"list" required:"true"`
31363166
31373167 // The query that is used to retrieve the observation data for the DataSource.
3138 SelectSqlQuery *string `type:"string" required:"true"`
3168 SelectSqlQuery *string `min:"1" type:"string" required:"true"`
31393169
31403170 // The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to
31413171 // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more
31423172 // information, see Role templates (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html)
31433173 // for data pipelines.
3144 ServiceRole *string `type:"string" required:"true"`
3174 ServiceRole *string `min:"1" type:"string" required:"true"`
31453175
31463176 // The subnet ID to be used to access a VPC-based RDS DB instance. This attribute
31473177 // is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon
31483178 // S3.
3149 SubnetId *string `type:"string" required:"true"`
3179 SubnetId *string `min:"1" type:"string" required:"true"`
31503180
31513181 metadataRDSDataSpec `json:"-" xml:"-"`
31523182 }
31683198 // The database details of an Amazon RDS database.
31693199 type RDSDatabase struct {
31703200 // The name of a database hosted on an RDS DB instance.
3171 DatabaseName *string `type:"string" required:"true"`
3201 DatabaseName *string `min:"1" type:"string" required:"true"`
31723202
31733203 // The ID of an RDS DB instance.
3174 InstanceIdentifier *string `type:"string" required:"true"`
3204 InstanceIdentifier *string `min:"1" type:"string" required:"true"`
31753205
31763206 metadataRDSDatabase `json:"-" xml:"-"`
31773207 }
31953225 // The password to be used by Amazon ML to connect to a database on an RDS DB
31963226 // instance. The password should have sufficient permissions to execute the
31973227 // RDSSelectQuery query.
3198 Password *string `type:"string" required:"true"`
3228 Password *string `min:"8" type:"string" required:"true"`
31993229
32003230 // The username to be used by Amazon ML to connect to database on an Amazon
32013231 // RDS instance. The username should have sufficient permissions to execute
32023232 // an RDSSelectSqlQuery query.
3203 Username *string `type:"string" required:"true"`
3233 Username *string `min:"1" type:"string" required:"true"`
32043234
32053235 metadataRDSDatabaseCredentials `json:"-" xml:"-"`
32063236 }
32243254 // The ID of the Data Pipeline instance that is used to carry to copy data from
32253255 // Amazon RDS to Amazon S3. You can use the ID to find details about the instance
32263256 // in the Data Pipeline console.
3227 DataPipelineId *string `type:"string"`
3257 DataPipelineId *string `min:"1" type:"string"`
32283258
32293259 // The database details required to connect to an Amazon RDS.
32303260 Database *RDSDatabase `type:"structure"`
32323262 // The username to be used by Amazon ML to connect to database on an Amazon
32333263 // RDS instance. The username should have sufficient permissions to execute
32343264 // an RDSSelectSqlQuery query.
3235 DatabaseUserName *string `type:"string"`
3265 DatabaseUserName *string `min:"1" type:"string"`
32363266
32373267 // The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance
32383268 // to carry out the copy task from Amazon RDS to Amazon S3. For more information,
32393269 // see Role templates (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html)
32403270 // for data pipelines.
3241 ResourceRole *string `type:"string"`
3271 ResourceRole *string `min:"1" type:"string"`
32423272
32433273 // The SQL query that is supplied during CreateDataSourceFromRDS. Returns only
32443274 // if Verbose is true in GetDataSourceInput.
3245 SelectSqlQuery *string `type:"string"`
3275 SelectSqlQuery *string `min:"1" type:"string"`
32463276
32473277 // The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to
32483278 // monitor the progress of the copy task from Amazon RDS to Amazon S3. For more
32493279 // information, see Role templates (http://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html)
32503280 // for data pipelines.
3251 ServiceRole *string `type:"string"`
3281 ServiceRole *string `min:"1" type:"string"`
32523282
32533283 metadataRDSMetadata `json:"-" xml:"-"`
32543284 }
33143344 // Describes the splitting specifications for a DataSource.
33153345 DataRearrangement *string `type:"string"`
33163346
3317 // Describes the schema for an Amazon Redshift DataSource.
3347 // A JSON string that represents the schema for an Amazon Redshift DataSource.
3348 // The DataSchema defines the structure of the observation data in the data
3349 // file(s) referenced in the DataSource.
3350 //
3351 // A DataSchema is not required if you specify a DataSchemaUri.
3352 //
3353 // Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames
3354 // have an array of key-value pairs for their value. Use the following format
3355 // to define your DataSchema.
3356 //
3357 // { "version": "1.0",
3358 //
3359 // "recordAnnotationFieldName": "F1",
3360 //
3361 // "recordWeightFieldName": "F2",
3362 //
3363 // "targetFieldName": "F3",
3364 //
3365 // "dataFormat": "CSV",
3366 //
3367 // "dataFileContainsHeader": true,
3368 //
3369 // "attributes": [
3370 //
3371 // { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType":
3372 // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName":
3373 // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL"
3374 // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
3375 // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE"
3376 // } ],
3377 //
3378 // "excludedVariableNames": [ "F6" ] }
33183379 DataSchema *string `type:"string"`
33193380
33203381 // Describes the schema location for an Amazon Redshift DataSource.
33333394
33343395 // Describes the SQL Query to execute on an Amazon Redshift database for an
33353396 // Amazon Redshift DataSource.
3336 SelectSqlQuery *string `type:"string" required:"true"`
3397 SelectSqlQuery *string `min:"1" type:"string" required:"true"`
33373398
33383399 metadataRedshiftDataSpec `json:"-" xml:"-"`
33393400 }
33563417 // database.
33573418 type RedshiftDatabase struct {
33583419 // The ID of an Amazon Redshift cluster.
3359 ClusterIdentifier *string `type:"string" required:"true"`
3420 ClusterIdentifier *string `min:"1" type:"string" required:"true"`
33603421
33613422 // The name of a database hosted on an Amazon Redshift cluster.
3362 DatabaseName *string `type:"string" required:"true"`
3423 DatabaseName *string `min:"1" type:"string" required:"true"`
33633424
33643425 metadataRedshiftDatabase `json:"-" xml:"-"`
33653426 }
33853446 // Redshift cluster. The password should have sufficient permissions to execute
33863447 // a RedshiftSelectSqlQuery query. The password should be valid for an Amazon
33873448 // Redshift USER (http://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html).
3388 Password *string `type:"string" required:"true"`
3449 Password *string `min:"8" type:"string" required:"true"`
33893450
33903451 // A username to be used by Amazon Machine Learning (Amazon ML)to connect to
33913452 // a database on an Amazon Redshift cluster. The username should have sufficient
33923453 // permissions to execute the RedshiftSelectSqlQuery query. The username should
33933454 // be valid for an Amazon Redshift USER (http://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html).
3394 Username *string `type:"string" required:"true"`
3455 Username *string `min:"1" type:"string" required:"true"`
33953456
33963457 metadataRedshiftDatabaseCredentials `json:"-" xml:"-"`
33973458 }
34163477 // a database on an Amazon Redshift cluster. The username should have sufficient
34173478 // permissions to execute the RedshiftSelectSqlQuery query. The username should
34183479 // be valid for an Amazon Redshift USER (http://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html).
3419 DatabaseUserName *string `type:"string"`
3480 DatabaseUserName *string `min:"1" type:"string"`
34203481
34213482 // Describes the database details required to connect to an Amazon Redshift
34223483 // database.
34243485
34253486 // The SQL query that is specified during CreateDataSourceFromRedshift. Returns
34263487 // only if Verbose is true in GetDataSourceInput.
3427 SelectSqlQuery *string `type:"string"`
3488 SelectSqlQuery *string `min:"1" type:"string"`
34283489
34293490 metadataRedshiftMetadata `json:"-" xml:"-"`
34303491 }
34533514 // Describes the splitting requirement of a Datasource.
34543515 DataRearrangement *string `type:"string"`
34553516
3456 // Describes the schema for an Amazon S3 DataSource.
3517 // A JSON string that represents the schema for an Amazon S3 DataSource. The
3518 // DataSchema defines the structure of the observation data in the data file(s)
3519 // referenced in the DataSource.
3520 //
3521 // Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames
3522 // have an array of key-value pairs for their value. Use the following format
3523 // to define your DataSchema.
3524 //
3525 // { "version": "1.0",
3526 //
3527 // "recordAnnotationFieldName": "F1",
3528 //
3529 // "recordWeightFieldName": "F2",
3530 //
3531 // "targetFieldName": "F3",
3532 //
3533 // "dataFormat": "CSV",
3534 //
3535 // "dataFileContainsHeader": true,
3536 //
3537 // "attributes": [
3538 //
3539 // { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType":
3540 // "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName":
3541 // "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL"
3542 // }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType":
3543 // "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE"
3544 // } ],
3545 //
3546 // "excludedVariableNames": [ "F6" ] }
34573547 DataSchema *string `type:"string"`
34583548
34593549 // Describes the schema Location in Amazon S3.
34783568
34793569 type UpdateBatchPredictionInput struct {
34803570 // The ID assigned to the BatchPrediction during creation.
3481 BatchPredictionId *string `type:"string" required:"true"`
3571 BatchPredictionId *string `min:"1" type:"string" required:"true"`
34823572
34833573 // A new user-supplied name or description of the BatchPrediction.
34843574 BatchPredictionName *string `type:"string" required:"true"`
35063596 type UpdateBatchPredictionOutput struct {
35073597 // The ID assigned to the BatchPrediction during creation. This value should
35083598 // be identical to the value of the BatchPredictionId in the request.
3509 BatchPredictionId *string `type:"string"`
3599 BatchPredictionId *string `min:"1" type:"string"`
35103600
35113601 metadataUpdateBatchPredictionOutput `json:"-" xml:"-"`
35123602 }
35273617
35283618 type UpdateDataSourceInput struct {
35293619 // The ID assigned to the DataSource during creation.
3530 DataSourceId *string `type:"string" required:"true"`
3620 DataSourceId *string `min:"1" type:"string" required:"true"`
35313621
35323622 // A new user-supplied name or description of the DataSource that will replace
35333623 // the current description.
35563646 type UpdateDataSourceOutput struct {
35573647 // The ID assigned to the DataSource during creation. This value should be identical
35583648 // to the value of the DataSourceID in the request.
3559 DataSourceId *string `type:"string"`
3649 DataSourceId *string `min:"1" type:"string"`
35603650
35613651 metadataUpdateDataSourceOutput `json:"-" xml:"-"`
35623652 }
35773667
35783668 type UpdateEvaluationInput struct {
35793669 // The ID assigned to the Evaluation during creation.
3580 EvaluationId *string `type:"string" required:"true"`
3670 EvaluationId *string `min:"1" type:"string" required:"true"`
35813671
35823672 // A new user-supplied name or description of the Evaluation that will replace
35833673 // the current content.
36063696 type UpdateEvaluationOutput struct {
36073697 // The ID assigned to the Evaluation during creation. This value should be identical
36083698 // to the value of the Evaluation in the request.
3609 EvaluationId *string `type:"string"`
3699 EvaluationId *string `min:"1" type:"string"`
36103700
36113701 metadataUpdateEvaluationOutput `json:"-" xml:"-"`
36123702 }
36273717
36283718 type UpdateMLModelInput struct {
36293719 // The ID assigned to the MLModel during creation.
3630 MLModelId *string `type:"string" required:"true"`
3720 MLModelId *string `min:"1" type:"string" required:"true"`
36313721
36323722 // A user-supplied name or description of the MLModel.
36333723 MLModelName *string `type:"string"`
36633753 type UpdateMLModelOutput struct {
36643754 // The ID assigned to the MLModel during creation. This value should be identical
36653755 // to the value of the MLModelID in the request.
3666 MLModelId *string `type:"string"`
3756 MLModelId *string `min:"1" type:"string"`
36673757
36683758 metadataUpdateMLModelOutput `json:"-" xml:"-"`
36693759 }
+3
-3
service/mobileanalytics/api.go less more
4646
4747 // A name signifying an event that occurred in your app. This is used for grouping
4848 // and aggregating like events together for reporting purposes.
49 EventType *string `locationName:"eventType" type:"string" required:"true"`
49 EventType *string `locationName:"eventType" min:"1" type:"string" required:"true"`
5050
5151 // A collection of key-value pairs that gives additional, measurable context
5252 // to the event. The key-value pairs are specified by the developer.
6262 Timestamp *string `locationName:"timestamp" type:"string" required:"true"`
6363
6464 // The version of the event.
65 Version *string `locationName:"version" type:"string"`
65 Version *string `locationName:"version" min:"1" type:"string"`
6666
6767 metadataEvent `json:"-" xml:"-"`
6868 }
134134 Duration *int64 `locationName:"duration" type:"long"`
135135
136136 // A unique identifier for the session
137 Id *string `locationName:"id" type:"string"`
137 Id *string `locationName:"id" min:"1" type:"string"`
138138
139139 // The time the event started in ISO 8601 standard date time format. For example,
140140 // 2014-06-30T19:07:47.885Z
+3
-3
service/opsworks/api.go less more
26392639 // which typically takes several minutes. IgnoreMetricsTime allows you to direct
26402640 // AWS OpsWorks to suppress scaling events long enough to get the new instances
26412641 // online.
2642 IgnoreMetricsTime *int64 `type:"integer"`
2642 IgnoreMetricsTime *int64 `min:"1" type:"integer"`
26432643
26442644 // The number of instances to add or remove when the load exceeds a threshold.
26452645 InstanceCount *int64 `type:"integer"`
26532653
26542654 // The amount of time, in minutes, that the load must exceed a threshold before
26552655 // more instances are added or removed.
2656 ThresholdsWaitTime *int64 `type:"integer"`
2656 ThresholdsWaitTime *int64 `min:"1" type:"integer"`
26572657
26582658 metadataAutoScalingThresholds `json:"-" xml:"-"`
26592659 }
55905590 // at the end of this period, the user will no longer be able to use the credentials
55915591 // to log in. If the user is logged in at the time, he or she automatically
55925592 // will be logged out.
5593 ValidForInMinutes *int64 `type:"integer"`
5593 ValidForInMinutes *int64 `min:"60" type:"integer"`
55945594
55955595 metadataGrantAccessInput `json:"-" xml:"-"`
55965596 }
+85
-44
service/route53/api.go less more
12221222 type ChangeBatch struct {
12231223 // A complex type that contains one Change element for each resource record
12241224 // set that you want to create or delete.
1225 Changes []*Change `locationNameList:"Change" type:"list" required:"true"`
1225 Changes []*Change `locationNameList:"Change" min:"1" type:"list" required:"true"`
12261226
12271227 // Optional: Any comments you want to include about a change batch request.
12281228 Comment *string `type:"string"`
13471347 type ChangeTagsForResourceInput struct {
13481348 // A complex type that contains a list of Tag elements. Each Tag element identifies
13491349 // a tag that you want to add or update for the specified resource.
1350 AddTags []*Tag `locationNameList:"Tag" type:"list"`
1350 AddTags []*Tag `locationNameList:"Tag" min:"1" type:"list"`
13511351
13521352 // A list of Tag keys that you want to remove from the specified resource.
1353 RemoveTagKeys []*string `locationNameList:"Key" type:"list"`
1353 RemoveTagKeys []*string `locationNameList:"Key" min:"1" type:"list"`
13541354
13551355 // The ID of the resource for which you want to add, change, or delete tags.
13561356 ResourceId *string `location:"uri" locationName:"ResourceId" type:"string" required:"true"`
14091409 //
14101410 // Valid characters are any Unicode code points that are legal in an XML 1.0
14111411 // document. The UTF-8 encoding of the value must be less than 128 bytes.
1412 CallerReference *string `type:"string" required:"true"`
1412 CallerReference *string `min:"1" type:"string" required:"true"`
14131413
14141414 // A complex type that contains health check configuration.
14151415 HealthCheckConfig *HealthCheckConfig `type:"structure" required:"true"`
14671467 //
14681468 // Valid characters are any Unicode code points that are legal in an XML 1.0
14691469 // document. The UTF-8 encoding of the value must be less than 128 bytes.
1470 CallerReference *string `type:"string" required:"true"`
1470 CallerReference *string `min:"1" type:"string" required:"true"`
14711471
14721472 // The delegation set id of the reusable delgation set whose NS records you
14731473 // want to assign to the new hosted zone.
15521552 //
15531553 // Valid characters are any Unicode code points that are legal in an XML 1.0
15541554 // document. The UTF-8 encoding of the value must be less than 128 bytes.
1555 CallerReference *string `type:"string" required:"true"`
1555 CallerReference *string `min:"1" type:"string" required:"true"`
15561556
15571557 // The ID of the hosted zone whose delegation set you want to mark as reusable.
15581558 // It is an optional parameter.
16011601
16021602 // A complex type that contains name server information.
16031603 type DelegationSet struct {
1604 CallerReference *string `type:"string"`
1604 CallerReference *string `min:"1" type:"string"`
16051605
16061606 Id *string `type:"string"`
16071607
16081608 // A complex type that contains the authoritative name servers for the hosted
16091609 // zone. Use the method provided by your domain registrar to add an NS record
16101610 // to your domain for each NameServer that is assigned to your hosted zone.
1611 NameServers []*string `locationNameList:"NameServer" type:"list" required:"true"`
1611 NameServers []*string `locationNameList:"NameServer" min:"1" type:"list" required:"true"`
16121612
16131613 metadataDelegationSet `json:"-" xml:"-"`
16141614 }
18181818 //
18191819 // Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode
18201820 // returns an InvalidInput error.
1821 ContinentCode *string `type:"string"`
1821 ContinentCode *string `min:"2" type:"string"`
18221822
18231823 // The code for a country geo location. The default location uses '*' for the
18241824 // country code and will match all locations that are not matched by a geo location.
18251825 //
18261826 // The default geo location uses a * for the country code. All other country
18271827 // codes follow the ISO 3166 two-character code.
1828 CountryCode *string `type:"string"`
1828 CountryCode *string `min:"1" type:"string"`
18291829
18301830 // The code for a country's subdivision (e.g., a province of Canada). A subdivision
18311831 // code is only valid with the appropriate country code.
18321832 //
18331833 // Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput
18341834 // error.
1835 SubdivisionCode *string `type:"string"`
1835 SubdivisionCode *string `min:"1" type:"string"`
18361836
18371837 metadataGeoLocation `json:"-" xml:"-"`
18381838 }
18551855 type GeoLocationDetails struct {
18561856 // The code for a continent geo location. Note: only continent locations have
18571857 // a continent code.
1858 ContinentCode *string `type:"string"`
1858 ContinentCode *string `min:"2" type:"string"`
18591859
18601860 // The name of the continent. This element is only present if ContinentCode
18611861 // is also present.
1862 ContinentName *string `type:"string"`
1862 ContinentName *string `min:"1" type:"string"`
18631863
18641864 // The code for a country geo location. The default location uses '*' for the
18651865 // country code and will match all locations that are not matched by a geo location.
18661866 //
18671867 // The default geo location uses a * for the country code. All other country
18681868 // codes follow the ISO 3166 two-character code.
1869 CountryCode *string `type:"string"`
1869 CountryCode *string `min:"1" type:"string"`
18701870
18711871 // The name of the country. This element is only present if CountryCode is also
18721872 // present.
1873 CountryName *string `type:"string"`
1873 CountryName *string `min:"1" type:"string"`
18741874
18751875 // The code for a country's subdivision (e.g., a province of Canada). A subdivision
18761876 // code is only valid with the appropriate country code.
1877 SubdivisionCode *string `type:"string"`
1877 SubdivisionCode *string `min:"1" type:"string"`
18781878
18791879 // The name of the subdivision. This element is only present if SubdivisionCode
18801880 // is also present.
1881 SubdivisionName *string `type:"string"`
1881 SubdivisionName *string `min:"1" type:"string"`
18821882
18831883 metadataGeoLocationDetails `json:"-" xml:"-"`
18841884 }
19961996 //
19971997 // Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode
19981998 // returns an InvalidInput error.
1999 ContinentCode *string `location:"querystring" locationName:"continentcode" type:"string"`
1999 ContinentCode *string `location:"querystring" locationName:"continentcode" min:"2" type:"string"`
20002000
20012001 // The code for a country geo location. The default location uses '*' for the
20022002 // country code and will match all locations that are not matched by a geo location.
20032003 //
20042004 // The default geo location uses a * for the country code. All other country
20052005 // codes follow the ISO 3166 two-character code.
2006 CountryCode *string `location:"querystring" locationName:"countrycode" type:"string"`
2006 CountryCode *string `location:"querystring" locationName:"countrycode" min:"1" type:"string"`
20072007
20082008 // The code for a country's subdivision (e.g., a province of Canada). A subdivision
20092009 // code is only valid with the appropriate country code.
20102010 //
20112011 // Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput
20122012 // error.
2013 SubdivisionCode *string `location:"querystring" locationName:"subdivisioncode" type:"string"`
2013 SubdivisionCode *string `location:"querystring" locationName:"subdivisioncode" min:"1" type:"string"`
20142014
20152015 metadataGetGeoLocationInput `json:"-" xml:"-"`
20162016 }
23122312
23132313 // A complex type that contains information about VPCs associated with the specified
23142314 // hosted zone.
2315 VPCs []*VPC `locationNameList:"VPC" type:"list"`
2315 VPCs []*VPC `locationNameList:"VPC" min:"1" type:"list"`
23162316
23172317 metadataGetHostedZoneOutput `json:"-" xml:"-"`
23182318 }
23812381 // A complex type that contains identifying information about the health check.
23822382 type HealthCheck struct {
23832383 // A unique string that identifies the request to create the health check.
2384 CallerReference *string `type:"string" required:"true"`
2384 CallerReference *string `min:"1" type:"string" required:"true"`
23852385
23862386 // A complex type that contains the health check configuration.
23872387 HealthCheckConfig *HealthCheckConfig `type:"structure" required:"true"`
23892389 // The version of the health check. You can optionally pass this value in a
23902390 // call to UpdateHealthCheck to prevent overwriting another change to the health
23912391 // check.
2392 HealthCheckVersion *int64 `type:"long" required:"true"`
2392 HealthCheckVersion *int64 `min:"1" type:"long" required:"true"`
23932393
23942394 // The ID of the specified health check.
23952395 Id *string `type:"string" required:"true"`
24132413
24142414 // A complex type that contains the health check configuration.
24152415 type HealthCheckConfig struct {
2416 // For a specified parent health check, a list of HealthCheckId values for the
2417 // associated child health checks.
2418 ChildHealthChecks []*string `locationNameList:"ChildHealthCheck" type:"list"`
2419
24162420 // The number of consecutive health checks that an endpoint must pass or fail
24172421 // for Route 53 to change the current status of the endpoint from unhealthy
24182422 // to healthy or vice versa.
24202424 // Valid values are integers between 1 and 10. For more information, see "How
24212425 // Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon
24222426 // Route 53 Developer Guide.
2423 FailureThreshold *int64 `type:"integer"`
2427 FailureThreshold *int64 `min:"1" type:"integer"`
24242428
24252429 // Fully qualified domain name of the instance to be health checked.
24262430 FullyQualifiedDomainName *string `type:"string"`
24272431
2432 // The minimum number of child health checks that must be healthy for Route
2433 // 53 to consider the parent health check to be healthy. Valid values are integers
2434 // between 0 and 256, inclusive.
2435 HealthThreshold *int64 `type:"integer"`
2436
24282437 // IP Address of the instance being checked.
24292438 IPAddress *string `type:"string"`
2439
2440 // A boolean value that indicates whether the status of health check should
2441 // be inverted. For example, if a health check is healthy but Inverted is True,
2442 // then Route 53 considers the health check to be unhealthy.
2443 Inverted *bool `type:"boolean"`
2444
2445 // A Boolean value that indicates whether you want Route 53 to measure the latency
2446 // between health checkers in multiple AWS regions and your endpoint and to
2447 // display CloudWatch latency graphs in the Route 53 console.
2448 MeasureLatency *bool `type:"boolean"`
24302449
24312450 // Port on which connection will be opened to the instance to health check.
24322451 // For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified.
24332452 // For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
2434 Port *int64 `type:"integer"`
2453 Port *int64 `min:"1" type:"integer"`
24352454
24362455 // The number of seconds between the time that Route 53 gets a response from
24372456 // your endpoint and the time that it sends the next health-check request.
24382457 //
24392458 // Each Route 53 health checker makes requests at this interval. Valid values
24402459 // are 10 and 30. The default value is 30.
2441 RequestInterval *int64 `type:"integer"`
2460 RequestInterval *int64 `min:"10" type:"integer"`
24422461
24432462 // Path to ping on the instance to check the health. Required for HTTP, HTTPS,
24442463 // HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks, HTTP request is issued
25002519 // A complex type that contain information about the specified hosted zone.
25012520 type HostedZone struct {
25022521 // A unique string that identifies the request to create the hosted zone.
2503 CallerReference *string `type:"string" required:"true"`
2522 CallerReference *string `min:"1" type:"string" required:"true"`
25042523
25052524 // A complex type that contains the Comment element.
25062525 Config *HostedZoneConfig `type:"structure"`
25812600 //
25822601 // Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode
25832602 // returns an InvalidInput error.
2584 StartContinentCode *string `location:"querystring" locationName:"startcontinentcode" type:"string"`
2603 StartContinentCode *string `location:"querystring" locationName:"startcontinentcode" min:"2" type:"string"`
25852604
25862605 // The first country code in the lexicographic ordering of geo locations that
25872606 // you want the ListGeoLocations request to list.
25882607 //
25892608 // The default geo location uses a * for the country code. All other country
25902609 // codes follow the ISO 3166 two-character code.
2591 StartCountryCode *string `location:"querystring" locationName:"startcountrycode" type:"string"`
2610 StartCountryCode *string `location:"querystring" locationName:"startcountrycode" min:"1" type:"string"`
25922611
25932612 // The first subdivision code in the lexicographic ordering of geo locations
25942613 // that you want the ListGeoLocations request to list.
25952614 //
25962615 // Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput
25972616 // error.
2598 StartSubdivisionCode *string `location:"querystring" locationName:"startsubdivisioncode" type:"string"`
2617 StartSubdivisionCode *string `location:"querystring" locationName:"startsubdivisioncode" min:"1" type:"string"`
25992618
26002619 metadataListGeoLocationsInput `json:"-" xml:"-"`
26012620 }
26372656 // If the results were truncated, the continent code of the next geo location
26382657 // in the list. This element is present only if ListGeoLocationsResponse$IsTruncated
26392658 // is true and the next geo location to list is a continent location.
2640 NextContinentCode *string `type:"string"`
2659 NextContinentCode *string `min:"2" type:"string"`
26412660
26422661 // If the results were truncated, the country code of the next geo location
26432662 // in the list. This element is present only if ListGeoLocationsResponse$IsTruncated
26442663 // is true and the next geo location to list is not a continent location.
2645 NextCountryCode *string `type:"string"`
2664 NextCountryCode *string `min:"1" type:"string"`
26462665
26472666 // If the results were truncated, the subdivision code of the next geo location
26482667 // in the list. This element is present only if ListGeoLocationsResponse$IsTruncated
26492668 // is true and the next geo location has a subdivision.
2650 NextSubdivisionCode *string `type:"string"`
2669 NextSubdivisionCode *string `min:"1" type:"string"`
26512670
26522671 metadataListGeoLocationsOutput `json:"-" xml:"-"`
26532672 }
29522971 // DNS name and type, specify the value of ListResourceRecordSetsResponse$NextRecordIdentifier
29532972 // from the previous response to get the next resource record set that has the
29542973 // current DNS name and type.
2955 StartRecordIdentifier *string `location:"querystring" locationName:"identifier" type:"string"`
2974 StartRecordIdentifier *string `location:"querystring" locationName:"identifier" min:"1" type:"string"`
29562975
29572976 // The first name in the lexicographic ordering of domain names that you want
29582977 // the ListResourceRecordSets request to list.
30073026 // Weighted resource record sets only: If results were truncated for a given
30083027 // DNS name and type, the value of SetIdentifier for the next resource record
30093028 // set that has the current DNS name and type.
3010 NextRecordIdentifier *string `type:"string"`
3029 NextRecordIdentifier *string `min:"1" type:"string"`
30113030
30123031 // If the results were truncated, the name of the next record in the list. This
30133032 // element is present only if ListResourceRecordSetsResponse$IsTruncated is
31833202 type ListTagsForResourcesInput struct {
31843203 // A complex type that contains the ResourceId element for each resource for
31853204 // which you want to get a list of tags.
3186 ResourceIds []*string `locationNameList:"ResourceId" type:"list" required:"true"`
3205 ResourceIds []*string `locationNameList:"ResourceId" min:"1" type:"list" required:"true"`
31873206
31883207 // The type of the resources.
31893208 //
32953314 // Latency-based resource record sets only: Among resource record sets that
32963315 // have the same combination of DNS name and type, a value that specifies the
32973316 // AWS region for the current resource record set.
3298 Region *string `type:"string" enum:"ResourceRecordSetRegion"`
3317 Region *string `min:"1" type:"string" enum:"ResourceRecordSetRegion"`
32993318
33003319 // A complex type that contains the resource records for the current resource
33013320 // record set.
3302 ResourceRecords []*ResourceRecord `locationNameList:"ResourceRecord" type:"list"`
3321 ResourceRecords []*ResourceRecord `locationNameList:"ResourceRecord" min:"1" type:"list"`
33033322
33043323 // Weighted, Latency, Geo, and Failover resource record sets only: An identifier
33053324 // that differentiates among multiple resource record sets that have the same
33063325 // combination of DNS name and type.
3307 SetIdentifier *string `type:"string"`
3326 SetIdentifier *string `min:"1" type:"string"`
33083327
33093328 // The cache time to live for the current resource record set.
33103329 TTL *int64 `type:"long"`
33483367 ResourceType *string `type:"string" enum:"TagResourceType"`
33493368
33503369 // The tags associated with the specified resource.
3351 Tags []*Tag `locationNameList:"Tag" type:"list"`
3370 Tags []*Tag `locationNameList:"Tag" min:"1" type:"list"`
33523371
33533372 metadataResourceTagSet `json:"-" xml:"-"`
33543373 }
34243443 // >A complex type that contains information about the request to update a health
34253444 // check.
34263445 type UpdateHealthCheckInput struct {
3446 // For a specified parent health check, a list of HealthCheckId values for the
3447 // associated child health checks.
3448 //
3449 // Specify this value only if you want to change it.
3450 ChildHealthChecks []*string `locationNameList:"ChildHealthCheck" type:"list"`
3451
34273452 // The number of consecutive health checks that an endpoint must pass or fail
34283453 // for Route 53 to change the current status of the endpoint from unhealthy
34293454 // to healthy or vice versa.
34333458 // Route 53 Developer Guide.
34343459 //
34353460 // Specify this value only if you want to change it.
3436 FailureThreshold *int64 `type:"integer"`
3461 FailureThreshold *int64 `min:"1" type:"integer"`
34373462
34383463 // Fully qualified domain name of the instance to be health checked.
34393464 //
34473472 // value with the current value in the health check, which prevents you from
34483473 // updating the health check when the versions don't match. Using HealthCheckVersion
34493474 // lets you prevent overwriting another change to the health check.
3450 HealthCheckVersion *int64 `type:"long"`
3475 HealthCheckVersion *int64 `min:"1" type:"long"`
3476
3477 // The minimum number of child health checks that must be healthy for Route
3478 // 53 to consider the parent health check to be healthy. Valid values are integers
3479 // between 0 and 256, inclusive.
3480 //
3481 // Specify this value only if you want to change it.
3482 HealthThreshold *int64 `type:"integer"`
34513483
34523484 // The IP address of the resource that you want to check.
34533485 //
34543486 // Specify this value only if you want to change it.
34553487 IPAddress *string `type:"string"`
34563488
3489 // A boolean value that indicates whether the status of health check should
3490 // be inverted. For example, if a health check is healthy but Inverted is True,
3491 // then Route 53 considers the health check to be unhealthy.
3492 //
3493 // Specify this value only if you want to change it.
3494 Inverted *bool `type:"boolean"`
3495
34573496 // The port on which you want Route 53 to open a connection to perform health
34583497 // checks.
34593498 //
34603499 // Specify this value only if you want to change it.
3461 Port *int64 `type:"integer"`
3500 Port *int64 `min:"1" type:"integer"`
34623501
34633502 // The path that you want Amazon Route 53 to request when performing health
34643503 // checks. The path can be any value for which your endpoint will return an
35673606 // A VPC ID
35683607 VPCId *string `type:"string"`
35693608
3570 VPCRegion *string `type:"string" enum:"VPCRegion"`
3609 VPCRegion *string `min:"1" type:"string" enum:"VPCRegion"`
35713610
35723611 metadataVPC `json:"-" xml:"-"`
35733612 }
36133652 HealthCheckTypeHttpsStrMatch = "HTTPS_STR_MATCH"
36143653 // @enum HealthCheckType
36153654 HealthCheckTypeTcp = "TCP"
3655 // @enum HealthCheckType
3656 HealthCheckTypeCalculated = "CALCULATED"
36163657 )
36173658
36183659 const (
+15
-2
service/route53/examples_test.go less more
128128 params := &route53.CreateHealthCheckInput{
129129 CallerReference: aws.String("HealthCheckNonce"), // Required
130130 HealthCheckConfig: &route53.HealthCheckConfig{ // Required
131 Type: aws.String("HealthCheckType"), // Required
131 Type: aws.String("HealthCheckType"), // Required
132 ChildHealthChecks: []*string{
133 aws.String("HealthCheckId"), // Required
134 // More values...
135 },
132136 FailureThreshold: aws.Int64(1),
133137 FullyQualifiedDomainName: aws.String("FullyQualifiedDomainName"),
138 HealthThreshold: aws.Int64(1),
134139 IPAddress: aws.String("IPAddress"),
140 Inverted: aws.Bool(true),
141 MeasureLatency: aws.Bool(true),
135142 Port: aws.Int64(1),
136143 RequestInterval: aws.Int64(1),
137144 ResourcePath: aws.String("ResourcePath"),
641648 svc := route53.New(nil)
642649
643650 params := &route53.UpdateHealthCheckInput{
644 HealthCheckId: aws.String("HealthCheckId"), // Required
651 HealthCheckId: aws.String("HealthCheckId"), // Required
652 ChildHealthChecks: []*string{
653 aws.String("HealthCheckId"), // Required
654 // More values...
655 },
645656 FailureThreshold: aws.Int64(1),
646657 FullyQualifiedDomainName: aws.String("FullyQualifiedDomainName"),
647658 HealthCheckVersion: aws.Int64(1),
659 HealthThreshold: aws.Int64(1),
648660 IPAddress: aws.String("IPAddress"),
661 Inverted: aws.Bool(true),
649662 Port: aws.Int64(1),
650663 ResourcePath: aws.String("ResourcePath"),
651664 SearchString: aws.String("SearchString"),
+2
-2
service/route53domains/api.go less more
18781878 // Valid values: Integer from 1 to 10
18791879 //
18801880 // Required: Yes
1881 DurationInYears *int64 `type:"integer" required:"true"`
1881 DurationInYears *int64 `min:"1" type:"integer" required:"true"`
18821882
18831883 // Reserved for future use.
18841884 IdnLangCode *string `type:"string"`
21502150 // Valid values: Integer from 1 to 10
21512151 //
21522152 // Required: Yes
2153 DurationInYears *int64 `type:"integer" required:"true"`
2153 DurationInYears *int64 `min:"1" type:"integer" required:"true"`
21542154
21552155 // Reserved for future use.
21562156 IdnLangCode *string `type:"string"`
+249
-47
service/s3/api.go less more
475475 return
476476 }
477477
478 // Returns the lifecycle configuration information set on the bucket.
478 // Deprecated, see the GetBucketLifecycleConfiguration operation.
479479 func (c *S3) GetBucketLifecycle(input *GetBucketLifecycleInput) (*GetBucketLifecycleOutput, error) {
480480 req, out := c.GetBucketLifecycleRequest(input)
481 err := req.Send()
482 return out, err
483 }
484
485 const opGetBucketLifecycleConfiguration = "GetBucketLifecycleConfiguration"
486
487 // GetBucketLifecycleConfigurationRequest generates a request for the GetBucketLifecycleConfiguration operation.
488 func (c *S3) GetBucketLifecycleConfigurationRequest(input *GetBucketLifecycleConfigurationInput) (req *request.Request, output *GetBucketLifecycleConfigurationOutput) {
489 op := &request.Operation{
490 Name: opGetBucketLifecycleConfiguration,
491 HTTPMethod: "GET",
492 HTTPPath: "/{Bucket}?lifecycle",
493 }
494
495 if input == nil {
496 input = &GetBucketLifecycleConfigurationInput{}
497 }
498
499 req = c.newRequest(op, input, output)
500 output = &GetBucketLifecycleConfigurationOutput{}
501 req.Data = output
502 return
503 }
504
505 // Returns the lifecycle configuration information set on the bucket.
506 func (c *S3) GetBucketLifecycleConfiguration(input *GetBucketLifecycleConfigurationInput) (*GetBucketLifecycleConfigurationOutput, error) {
507 req, out := c.GetBucketLifecycleConfigurationRequest(input)
481508 err := req.Send()
482509 return out, err
483510 }
11531180 return
11541181 }
11551182
1183 // Deprecated, see the PutBucketLifecycleConfiguration operation.
1184 func (c *S3) PutBucketLifecycle(input *PutBucketLifecycleInput) (*PutBucketLifecycleOutput, error) {
1185 req, out := c.PutBucketLifecycleRequest(input)
1186 err := req.Send()
1187 return out, err
1188 }
1189
1190 const opPutBucketLifecycleConfiguration = "PutBucketLifecycleConfiguration"
1191
1192 // PutBucketLifecycleConfigurationRequest generates a request for the PutBucketLifecycleConfiguration operation.
1193 func (c *S3) PutBucketLifecycleConfigurationRequest(input *PutBucketLifecycleConfigurationInput) (req *request.Request, output *PutBucketLifecycleConfigurationOutput) {
1194 op := &request.Operation{
1195 Name: opPutBucketLifecycleConfiguration,
1196 HTTPMethod: "PUT",
1197 HTTPPath: "/{Bucket}?lifecycle",
1198 }
1199
1200 if input == nil {
1201 input = &PutBucketLifecycleConfigurationInput{}
1202 }
1203
1204 req = c.newRequest(op, input, output)
1205 output = &PutBucketLifecycleConfigurationOutput{}
1206 req.Data = output
1207 return
1208 }
1209
11561210 // Sets lifecycle configuration for your bucket. If a lifecycle configuration
11571211 // exists, it replaces it.
1158 func (c *S3) PutBucketLifecycle(input *PutBucketLifecycleInput) (*PutBucketLifecycleOutput, error) {
1159 req, out := c.PutBucketLifecycleRequest(input)
1212 func (c *S3) PutBucketLifecycleConfiguration(input *PutBucketLifecycleConfigurationInput) (*PutBucketLifecycleConfigurationOutput, error) {
1213 req, out := c.PutBucketLifecycleConfigurationRequest(input)
11601214 err := req.Send()
11611215 return out, err
11621216 }
15581612 type AbortMultipartUploadInput struct {
15591613 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
15601614
1561 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
1615 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
15621616
15631617 // Confirms that the requester knows that she or he will be charged for the
15641618 // request. Bucket owners need not specify this parameter in their requests.
16541708 return s.String()
16551709 }
16561710
1711 type BucketLifecycleConfiguration struct {
1712 Rules []*LifecycleRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
1713
1714 metadataBucketLifecycleConfiguration `json:"-" xml:"-"`
1715 }
1716
1717 type metadataBucketLifecycleConfiguration struct {
1718 SDKShapeTraits bool `type:"structure"`
1719 }
1720
1721 // String returns the string representation
1722 func (s BucketLifecycleConfiguration) String() string {
1723 return awsutil.Prettify(s)
1724 }
1725
1726 // GoString returns the string representation
1727 func (s BucketLifecycleConfiguration) GoString() string {
1728 return s.String()
1729 }
1730
16571731 type BucketLoggingStatus struct {
16581732 LoggingEnabled *LoggingEnabled `type:"structure"`
16591733
16751749 }
16761750
16771751 type CORSConfiguration struct {
1678 CORSRules []*CORSRule `locationName:"CORSRule" type:"list" flattened:"true"`
1752 CORSRules []*CORSRule `locationName:"CORSRule" type:"list" flattened:"true" required:"true"`
16791753
16801754 metadataCORSConfiguration `json:"-" xml:"-"`
16811755 }
17001774
17011775 // Identifies HTTP methods that the domain/origin specified in the rule is allowed
17021776 // to execute.
1703 AllowedMethods []*string `locationName:"AllowedMethod" type:"list" flattened:"true"`
1777 AllowedMethods []*string `locationName:"AllowedMethod" type:"list" flattened:"true" required:"true"`
17041778
17051779 // One or more origins you want customers to be able to access the bucket from.
1706 AllowedOrigins []*string `locationName:"AllowedOrigin" type:"list" flattened:"true"`
1780 AllowedOrigins []*string `locationName:"AllowedOrigin" type:"list" flattened:"true" required:"true"`
17071781
17081782 // One or more headers in the response that you want customers to be able to
17091783 // access from their applications (for example, from a JavaScript XMLHttpRequest
17851859 type CompleteMultipartUploadInput struct {
17861860 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
17871861
1788 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
1862 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
17891863
17901864 MultipartUpload *CompletedMultipartUpload `locationName:"CompleteMultipartUpload" type:"structure"`
17911865
18241898 // date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
18251899 Expiration *string `location:"header" locationName:"x-amz-expiration" type:"string"`
18261900
1827 Key *string `type:"string"`
1901 Key *string `min:"1" type:"string"`
18281902
18291903 Location *string `type:"string"`
18301904
20072081 // Allows grantee to write the ACL for the applicable object.
20082082 GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
20092083
2010 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
2084 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
20112085
20122086 // A map of metadata to store with the object in S3.
20132087 Metadata map[string]*string `location:"headers" locationName:"x-amz-meta-" type:"map"`
22862360 // Allows grantee to write the ACL for the applicable object.
22872361 GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
22882362
2289 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
2363 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
22902364
22912365 // A map of metadata to store with the object in S3.
22922366 Metadata map[string]*string `location:"headers" locationName:"x-amz-meta-" type:"map"`
23522426 Bucket *string `locationName:"Bucket" type:"string"`
23532427
23542428 // Object key for which the multipart upload was initiated.
2355 Key *string `type:"string"`
2429 Key *string `min:"1" type:"string"`
23562430
23572431 // If present, indicates that the requester was successfully charged for the
23582432 // request.
26922766 IsLatest *bool `type:"boolean"`
26932767
26942768 // The object key.
2695 Key *string `type:"string"`
2769 Key *string `min:"1" type:"string"`
26962770
26972771 // Date and time the object was last modified.
26982772 LastModified *time.Time `type:"timestamp" timestampFormat:"iso8601"`
27222796 type DeleteObjectInput struct {
27232797 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
27242798
2725 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
2799 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
27262800
27272801 // The concatenation of the authentication device's serial number, a space,
27282802 // and the value that is displayed on your authentication device.
28472921
28482922 DeleteMarkerVersionId *string `type:"string"`
28492923
2850 Key *string `type:"string"`
2924 Key *string `min:"1" type:"string"`
28512925
28522926 VersionId *string `type:"string"`
28532927
28732947 // replicas of the object identified by the rule.
28742948 Bucket *string `type:"string" required:"true"`
28752949
2950 // The class of storage used to store the object.
2951 StorageClass *string `type:"string" enum:"StorageClass"`
2952
28762953 metadataDestination `json:"-" xml:"-"`
28772954 }
28782955
28932970 type Error struct {
28942971 Code *string `type:"string"`
28952972
2896 Key *string `type:"string"`
2973 Key *string `min:"1" type:"string"`
28972974
28982975 Message *string `type:"string"`
28992976
29182995
29192996 type ErrorDocument struct {
29202997 // The object key name to use when a 4XX class error occurs.
2921 Key *string `type:"string" required:"true"`
2998 Key *string `min:"1" type:"string" required:"true"`
29222999
29233000 metadataErrorDocument `json:"-" xml:"-"`
29243001 }
30483125 return s.String()
30493126 }
30503127
3128 type GetBucketLifecycleConfigurationInput struct {
3129 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
3130
3131 metadataGetBucketLifecycleConfigurationInput `json:"-" xml:"-"`
3132 }
3133
3134 type metadataGetBucketLifecycleConfigurationInput struct {
3135 SDKShapeTraits bool `type:"structure"`
3136 }
3137
3138 // String returns the string representation
3139 func (s GetBucketLifecycleConfigurationInput) String() string {
3140 return awsutil.Prettify(s)
3141 }
3142
3143 // GoString returns the string representation
3144 func (s GetBucketLifecycleConfigurationInput) GoString() string {
3145 return s.String()
3146 }
3147
3148 type GetBucketLifecycleConfigurationOutput struct {
3149 Rules []*LifecycleRule `locationName:"Rule" type:"list" flattened:"true"`
3150
3151 metadataGetBucketLifecycleConfigurationOutput `json:"-" xml:"-"`
3152 }
3153
3154 type metadataGetBucketLifecycleConfigurationOutput struct {
3155 SDKShapeTraits bool `type:"structure"`
3156 }
3157
3158 // String returns the string representation
3159 func (s GetBucketLifecycleConfigurationOutput) String() string {
3160 return awsutil.Prettify(s)
3161 }
3162
3163 // GoString returns the string representation
3164 func (s GetBucketLifecycleConfigurationOutput) GoString() string {
3165 return s.String()
3166 }
3167
30513168 type GetBucketLifecycleInput struct {
30523169 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
30533170
30693186 }
30703187
30713188 type GetBucketLifecycleOutput struct {
3072 Rules []*LifecycleRule `locationName:"Rule" type:"list" flattened:"true"`
3189 Rules []*Rule `locationName:"Rule" type:"list" flattened:"true"`
30733190
30743191 metadataGetBucketLifecycleOutput `json:"-" xml:"-"`
30753192 }
34483565 type GetObjectAclInput struct {
34493566 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
34503567
3451 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
3568 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
34523569
34533570 // Confirms that the requester knows that she or he will be charged for the
34543571 // request. Bucket owners need not specify this parameter in their requests.
35223639 // otherwise return a 412 (precondition failed).
35233640 IfUnmodifiedSince *time.Time `location:"header" locationName:"If-Unmodified-Since" type:"timestamp" timestampFormat:"rfc822"`
35243641
3525 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
3642 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
35263643
35273644 // Downloads the specified range bytes of an object. For more information about
35283645 // the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
37033820 type GetObjectTorrentInput struct {
37043821 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
37053822
3706 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
3823 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
37073824
37083825 // Confirms that the requester knows that she or he will be charged for the
37093826 // request. Bucket owners need not specify this parameter in their requests.
38653982 // otherwise return a 412 (precondition failed).
38663983 IfUnmodifiedSince *time.Time `location:"header" locationName:"If-Unmodified-Since" type:"timestamp" timestampFormat:"rfc822"`
38673984
3868 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
3985 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
38693986
38703987 // Downloads the specified range bytes of an object. For more information about
38713988 // the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
41264243 }
41274244
41284245 type LifecycleConfiguration struct {
4129 Rules []*LifecycleRule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
4246 Rules []*Rule `locationName:"Rule" type:"list" flattened:"true" required:"true"`
41304247
41314248 metadataLifecycleConfiguration `json:"-" xml:"-"`
41324249 }
41844301 // period in the object's lifetime.
41854302 NoncurrentVersionExpiration *NoncurrentVersionExpiration `type:"structure"`
41864303
4187 // Container for the transition rule that describes when noncurrent objects
4188 // transition to the GLACIER storage class. If your bucket is versioning-enabled
4189 // (or versioning is suspended), you can set this action to request that Amazon
4190 // S3 transition noncurrent object versions to the GLACIER storage class at
4191 // a specific period in the object's lifetime.
4192 NoncurrentVersionTransition *NoncurrentVersionTransition `type:"structure"`
4304 NoncurrentVersionTransitions []*NoncurrentVersionTransition `locationName:"NoncurrentVersionTransition" type:"list" flattened:"true"`
41934305
41944306 // Prefix identifying one or more objects to which the rule applies.
41954307 Prefix *string `type:"string" required:"true"`
41984310 // is not currently being applied.
41994311 Status *string `type:"string" required:"true" enum:"ExpirationStatus"`
42004312
4201 Transition *Transition `type:"structure"`
4313 Transitions []*Transition `locationName:"Transition" type:"list" flattened:"true"`
42024314
42034315 metadataLifecycleRule `json:"-" xml:"-"`
42044316 }
45534665 type ListPartsInput struct {
45544666 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
45554667
4556 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
4668 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
45574669
45584670 // Sets the maximum number of parts to return.
45594671 MaxParts *int64 `location:"querystring" locationName:"max-parts" type:"integer"`
45994711 IsTruncated *bool `type:"boolean"`
46004712
46014713 // Object key for which the multipart upload was initiated.
4602 Key *string `type:"string"`
4714 Key *string `min:"1" type:"string"`
46034715
46044716 // Maximum number of parts that were allowed in the response.
46054717 MaxParts *int64 `type:"integer"`
46834795 Initiator *Initiator `type:"structure"`
46844796
46854797 // Key of the object for which the multipart upload was initiated.
4686 Key *string `type:"string"`
4798 Key *string `min:"1" type:"string"`
46874799
46884800 Owner *Owner `type:"structure"`
46894801
47414853 }
47424854
47434855 // Container for the transition rule that describes when noncurrent objects
4744 // transition to the GLACIER storage class. If your bucket is versioning-enabled
4745 // (or versioning is suspended), you can set this action to request that Amazon
4746 // S3 transition noncurrent object versions to the GLACIER storage class at
4747 // a specific period in the object's lifetime.
4856 // transition to the STANDARD_IA or GLACIER storage class. If your bucket is
4857 // versioning-enabled (or versioning is suspended), you can set this action
4858 // to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA
4859 // or GLACIER storage class at a specific period in the object's lifetime.
47484860 type NoncurrentVersionTransition struct {
47494861 // Specifies the number of days an object is noncurrent before Amazon S3 can
47504862 // perform the associated action. For information about the noncurrent days
48504962 type Object struct {
48514963 ETag *string `type:"string"`
48524964
4853 Key *string `type:"string"`
4965 Key *string `min:"1" type:"string"`
48544966
48554967 LastModified *time.Time `type:"timestamp" timestampFormat:"iso8601"`
48564968
48804992
48814993 type ObjectIdentifier struct {
48824994 // Key name of the object to delete.
4883 Key *string `type:"string" required:"true"`
4995 Key *string `min:"1" type:"string" required:"true"`
48844996
48854997 // VersionId for the specific version of the object to delete.
48864998 VersionId *string `type:"string"`
49105022 IsLatest *bool `type:"boolean"`
49115023
49125024 // The object key.
4913 Key *string `type:"string"`
5025 Key *string `min:"1" type:"string"`
49145026
49155027 // Date and time the object was last modified.
49165028 LastModified *time.Time `type:"timestamp" timestampFormat:"iso8601"`
50585170 type PutBucketCorsInput struct {
50595171 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
50605172
5061 CORSConfiguration *CORSConfiguration `locationName:"CORSConfiguration" type:"structure"`
5173 CORSConfiguration *CORSConfiguration `locationName:"CORSConfiguration" type:"structure" required:"true"`
50625174
50635175 metadataPutBucketCorsInput `json:"-" xml:"-"`
50645176 }
50925204
50935205 // GoString returns the string representation
50945206 func (s PutBucketCorsOutput) GoString() string {
5207 return s.String()
5208 }
5209
5210 type PutBucketLifecycleConfigurationInput struct {
5211 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
5212
5213 LifecycleConfiguration *BucketLifecycleConfiguration `locationName:"LifecycleConfiguration" type:"structure"`
5214
5215 metadataPutBucketLifecycleConfigurationInput `json:"-" xml:"-"`
5216 }
5217
5218 type metadataPutBucketLifecycleConfigurationInput struct {
5219 SDKShapeTraits bool `type:"structure" payload:"LifecycleConfiguration"`
5220 }
5221
5222 // String returns the string representation
5223 func (s PutBucketLifecycleConfigurationInput) String() string {
5224 return awsutil.Prettify(s)
5225 }
5226
5227 // GoString returns the string representation
5228 func (s PutBucketLifecycleConfigurationInput) GoString() string {
5229 return s.String()
5230 }
5231
5232 type PutBucketLifecycleConfigurationOutput struct {
5233 metadataPutBucketLifecycleConfigurationOutput `json:"-" xml:"-"`
5234 }
5235
5236 type metadataPutBucketLifecycleConfigurationOutput struct {
5237 SDKShapeTraits bool `type:"structure"`
5238 }
5239
5240 // String returns the string representation
5241 func (s PutBucketLifecycleConfigurationOutput) String() string {
5242 return awsutil.Prettify(s)
5243 }
5244
5245 // GoString returns the string representation
5246 func (s PutBucketLifecycleConfigurationOutput) GoString() string {
50955247 return s.String()
50965248 }
50975249
55285680 // Allows grantee to write the ACL for the applicable bucket.
55295681 GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
55305682
5531 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
5683 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
55325684
55335685 // Confirms that the requester knows that she or he will be charged for the
55345686 // request. Bucket owners need not specify this parameter in their requests.
56205772 // Allows grantee to write the ACL for the applicable object.
56215773 GrantWriteACP *string `location:"header" locationName:"x-amz-grant-write-acp" type:"string"`
56225774
5623 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
5775 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
56245776
56255777 // A map of metadata to store with the object in S3.
56265778 Metadata map[string]*string `location:"headers" locationName:"x-amz-meta-" type:"map"`
59456097 type RestoreObjectInput struct {
59466098 Bucket *string `location:"uri" locationName:"Bucket" type:"string" required:"true"`
59476099
5948 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
6100 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
59496101
59506102 // Confirms that the requester knows that she or he will be charged for the
59516103 // request. Bucket owners need not specify this parameter in their requests.
60466198 return s.String()
60476199 }
60486200
6201 type Rule struct {
6202 Expiration *LifecycleExpiration `type:"structure"`
6203
6204 // Unique identifier for the rule. The value cannot be longer than 255 characters.
6205 ID *string `type:"string"`
6206
6207 // Specifies when noncurrent object versions expire. Upon expiration, Amazon
6208 // S3 permanently deletes the noncurrent object versions. You set this lifecycle
6209 // configuration action on a bucket that has versioning enabled (or suspended)
6210 // to request that Amazon S3 delete noncurrent object versions at a specific
6211 // period in the object's lifetime.
6212 NoncurrentVersionExpiration *NoncurrentVersionExpiration `type:"structure"`
6213
6214 // Container for the transition rule that describes when noncurrent objects
6215 // transition to the STANDARD_IA or GLACIER storage class. If your bucket is
6216 // versioning-enabled (or versioning is suspended), you can set this action
6217 // to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA
6218 // or GLACIER storage class at a specific period in the object's lifetime.
6219 NoncurrentVersionTransition *NoncurrentVersionTransition `type:"structure"`
6220
6221 // Prefix identifying one or more objects to which the rule applies.
6222 Prefix *string `type:"string" required:"true"`
6223
6224 // If 'Enabled', the rule is currently being applied. If 'Disabled', the rule
6225 // is not currently being applied.
6226 Status *string `type:"string" required:"true" enum:"ExpirationStatus"`
6227
6228 Transition *Transition `type:"structure"`
6229
6230 metadataRule `json:"-" xml:"-"`
6231 }
6232
6233 type metadataRule struct {
6234 SDKShapeTraits bool `type:"structure"`
6235 }
6236
6237 // String returns the string representation
6238 func (s Rule) String() string {
6239 return awsutil.Prettify(s)
6240 }
6241
6242 // GoString returns the string representation
6243 func (s Rule) GoString() string {
6244 return s.String()
6245 }
6246
60496247 type Tag struct {
60506248 // Name of the tag.
6051 Key *string `type:"string" required:"true"`
6249 Key *string `min:"1" type:"string" required:"true"`
60526250
60536251 // Value of the tag.
60546252 Value *string `type:"string" required:"true"`
62486446 // key was transmitted without error.
62496447 CopySourceSSECustomerKeyMD5 *string `location:"header" locationName:"x-amz-copy-source-server-side-encryption-customer-key-MD5" type:"string"`
62506448
6251 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
6449 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
62526450
62536451 // Part number of part being copied. This is a positive integer between 1 and
62546452 // 10,000.
63516549 // body cannot be determined automatically.
63526550 ContentLength *int64 `location:"header" locationName:"Content-Length" type:"integer"`
63536551
6354 Key *string `location:"uri" locationName:"Key" type:"string" required:"true"`
6552 Key *string `location:"uri" locationName:"Key" min:"1" type:"string" required:"true"`
63556553
63566554 // Part number of part being uploaded. This is a positive integer between 1
63576555 // and 10,000.
67146912 StorageClassStandard = "STANDARD"
67156913 // @enum StorageClass
67166914 StorageClassReducedRedundancy = "REDUCED_REDUNDANCY"
6915 // @enum StorageClass
6916 StorageClassStandardIa = "STANDARD_IA"
67176917 )
67186918
67196919 const (
67206920 // @enum TransitionStorageClass
67216921 TransitionStorageClassGlacier = "GLACIER"
6922 // @enum TransitionStorageClass
6923 TransitionStorageClassStandardIa = "STANDARD_IA"
67226924 )
67236925
67246926 const (
+2
-0
service/s3/customizations.go less more
2929 case opCreateBucket:
3030 // Auto-populate LocationConstraint with current region
3131 r.Handlers.Validate.PushFront(populateLocationConstraint)
32 case opCopyObject, opUploadPartCopy, opCompleteMultipartUpload:
33 r.Handlers.Unmarshal.PushFront(copyMultipartStatusOKUnmarhsalError)
3234 }
3335 }
3436 }
+5
-2
service/s3/customizations_test.go less more
3030 Bucket: aws.String("bucketname"),
3131 CORSConfiguration: &s3.CORSConfiguration{
3232 CORSRules: []*s3.CORSRule{
33 {AllowedMethods: []*string{aws.String("GET")}},
33 {
34 AllowedMethods: []*string{aws.String("GET")},
35 AllowedOrigins: []*string{aws.String("*")},
36 },
3437 },
3538 },
3639 })
4245 req, _ := svc.PutBucketLifecycleRequest(&s3.PutBucketLifecycleInput{
4346 Bucket: aws.String("bucketname"),
4447 LifecycleConfiguration: &s3.LifecycleConfiguration{
45 Rules: []*s3.LifecycleRule{
48 Rules: []*s3.Rule{
4649 {
4750 ID: aws.String("ID"),
4851 Prefix: aws.String("Prefix"),
+91
-20
service/s3/examples_test.go less more
433433 fmt.Println(resp)
434434 }
435435
436 func ExampleS3_GetBucketLifecycleConfiguration() {
437 svc := s3.New(nil)
438
439 params := &s3.GetBucketLifecycleConfigurationInput{
440 Bucket: aws.String("BucketName"), // Required
441 }
442 resp, err := svc.GetBucketLifecycleConfiguration(params)
443
444 if err != nil {
445 // Print the error, cast err to awserr.Error to get the Code and
446 // Message from an error.
447 fmt.Println(err.Error())
448 return
449 }
450
451 // Pretty-print the response data.
452 fmt.Println(resp)
453 }
454
436455 func ExampleS3_GetBucketLocation() {
437456 svc := s3.New(nil)
438457
915934
916935 params := &s3.PutBucketCorsInput{
917936 Bucket: aws.String("BucketName"), // Required
918 CORSConfiguration: &s3.CORSConfiguration{
919 CORSRules: []*s3.CORSRule{
937 CORSConfiguration: &s3.CORSConfiguration{ // Required
938 CORSRules: []*s3.CORSRule{ // Required
920939 { // Required
940 AllowedMethods: []*string{ // Required
941 aws.String("AllowedMethod"), // Required
942 // More values...
943 },
944 AllowedOrigins: []*string{ // Required
945 aws.String("AllowedOrigin"), // Required
946 // More values...
947 },
921948 AllowedHeaders: []*string{
922949 aws.String("AllowedHeader"), // Required
923950 // More values...
924951 },
925 AllowedMethods: []*string{
926 aws.String("AllowedMethod"), // Required
927 // More values...
928 },
929 AllowedOrigins: []*string{
930 aws.String("AllowedOrigin"), // Required
931 // More values...
932 },
933952 ExposeHeaders: []*string{
934953 aws.String("ExposeHeader"), // Required
935954 // More values...
959978 params := &s3.PutBucketLifecycleInput{
960979 Bucket: aws.String("BucketName"), // Required
961980 LifecycleConfiguration: &s3.LifecycleConfiguration{
981 Rules: []*s3.Rule{ // Required
982 { // Required
983 Prefix: aws.String("Prefix"), // Required
984 Status: aws.String("ExpirationStatus"), // Required
985 Expiration: &s3.LifecycleExpiration{
986 Date: aws.Time(time.Now()),
987 Days: aws.Int64(1),
988 },
989 ID: aws.String("ID"),
990 NoncurrentVersionExpiration: &s3.NoncurrentVersionExpiration{
991 NoncurrentDays: aws.Int64(1),
992 },
993 NoncurrentVersionTransition: &s3.NoncurrentVersionTransition{
994 NoncurrentDays: aws.Int64(1),
995 StorageClass: aws.String("TransitionStorageClass"),
996 },
997 Transition: &s3.Transition{
998 Date: aws.Time(time.Now()),
999 Days: aws.Int64(1),
1000 StorageClass: aws.String("TransitionStorageClass"),
1001 },
1002 },
1003 // More values...
1004 },
1005 },
1006 }
1007 resp, err := svc.PutBucketLifecycle(params)
1008
1009 if err != nil {
1010 // Print the error, cast err to awserr.Error to get the Code and
1011 // Message from an error.
1012 fmt.Println(err.Error())
1013 return
1014 }
1015
1016 // Pretty-print the response data.
1017 fmt.Println(resp)
1018 }
1019
1020 func ExampleS3_PutBucketLifecycleConfiguration() {
1021 svc := s3.New(nil)
1022
1023 params := &s3.PutBucketLifecycleConfigurationInput{
1024 Bucket: aws.String("BucketName"), // Required
1025 LifecycleConfiguration: &s3.BucketLifecycleConfiguration{
9621026 Rules: []*s3.LifecycleRule{ // Required
9631027 { // Required
9641028 Prefix: aws.String("Prefix"), // Required
9711035 NoncurrentVersionExpiration: &s3.NoncurrentVersionExpiration{
9721036 NoncurrentDays: aws.Int64(1),
9731037 },
974 NoncurrentVersionTransition: &s3.NoncurrentVersionTransition{
975 NoncurrentDays: aws.Int64(1),
976 StorageClass: aws.String("TransitionStorageClass"),
977 },
978 Transition: &s3.Transition{
979 Date: aws.Time(time.Now()),
980 Days: aws.Int64(1),
981 StorageClass: aws.String("TransitionStorageClass"),
1038 NoncurrentVersionTransitions: []*s3.NoncurrentVersionTransition{
1039 { // Required
1040 NoncurrentDays: aws.Int64(1),
1041 StorageClass: aws.String("TransitionStorageClass"),
1042 },
1043 // More values...
1044 },
1045 Transitions: []*s3.Transition{
1046 { // Required
1047 Date: aws.Time(time.Now()),
1048 Days: aws.Int64(1),
1049 StorageClass: aws.String("TransitionStorageClass"),
1050 },
1051 // More values...
9821052 },
9831053 },
9841054 // More values...
9851055 },
9861056 },
9871057 }
988 resp, err := svc.PutBucketLifecycle(params)
1058 resp, err := svc.PutBucketLifecycleConfiguration(params)
9891059
9901060 if err != nil {
9911061 // Print the error, cast err to awserr.Error to get the Code and
12021272 Rules: []*s3.ReplicationRule{ // Required
12031273 { // Required
12041274 Destination: &s3.Destination{ // Required
1205 Bucket: aws.String("BucketName"), // Required
1275 Bucket: aws.String("BucketName"), // Required
1276 StorageClass: aws.String("StorageClass"),
12061277 },
12071278 Prefix: aws.String("Prefix"), // Required
12081279 Status: aws.String("ReplicationRuleStatus"), // Required
+6
-0
service/s3/host_style_bucket.go less more
3333 return false
3434 }
3535
36 // GetBucketLocation should be able to be called from any region within
37 // a partition, and return the associated region of the bucket.
38 if r.Operation.Name == opGetBucketLocation {
39 return false
40 }
41
3642 // Use host-style if the bucket is DNS compatible
3743 return dnsCompatibleBucketName(bucket)
3844 }
+17
-1
service/s3/host_style_bucket_test.go less more
00 package s3_test
11
22 import (
3 "net/url"
34 "testing"
5
6 "github.com/stretchr/testify/assert"
7 "github.com/stretchr/testify/require"
48
59 "github.com/aws/aws-sdk-go/aws"
610 "github.com/aws/aws-sdk-go/internal/test/unit"
711 "github.com/aws/aws-sdk-go/service/s3"
8 "github.com/stretchr/testify/assert"
912 )
1013
1114 type s3BucketTest struct {
5861 s := s3.New(&aws.Config{S3ForcePathStyle: aws.Bool(true)})
5962 runTests(t, s, forcepathTests)
6063 }
64
65 func TestHostStyleBucketGetBucketLocation(t *testing.T) {
66 s := s3.New(nil)
67 req, _ := s.GetBucketLocationRequest(&s3.GetBucketLocationInput{
68 Bucket: aws.String("bucket"),
69 })
70
71 req.Build()
72 require.NoError(t, req.Error)
73 u, _ := url.Parse(req.HTTPRequest.URL.String())
74 assert.NotContains(t, u.Host, "bucket")
75 assert.Contains(t, u.Path, "bucket")
76 }
+8
-0
service/s3/s3iface/interface.go less more
7777
7878 GetBucketLifecycle(*s3.GetBucketLifecycleInput) (*s3.GetBucketLifecycleOutput, error)
7979
80 GetBucketLifecycleConfigurationRequest(*s3.GetBucketLifecycleConfigurationInput) (*request.Request, *s3.GetBucketLifecycleConfigurationOutput)
81
82 GetBucketLifecycleConfiguration(*s3.GetBucketLifecycleConfigurationInput) (*s3.GetBucketLifecycleConfigurationOutput, error)
83
8084 GetBucketLocationRequest(*s3.GetBucketLocationInput) (*request.Request, *s3.GetBucketLocationOutput)
8185
8286 GetBucketLocation(*s3.GetBucketLocationInput) (*s3.GetBucketLocationOutput, error)
176180 PutBucketLifecycleRequest(*s3.PutBucketLifecycleInput) (*request.Request, *s3.PutBucketLifecycleOutput)
177181
178182 PutBucketLifecycle(*s3.PutBucketLifecycleInput) (*s3.PutBucketLifecycleOutput, error)
183
184 PutBucketLifecycleConfigurationRequest(*s3.PutBucketLifecycleConfigurationInput) (*request.Request, *s3.PutBucketLifecycleConfigurationOutput)
185
186 PutBucketLifecycleConfiguration(*s3.PutBucketLifecycleConfigurationInput) (*s3.PutBucketLifecycleConfigurationOutput, error)
179187
180188 PutBucketLoggingRequest(*s3.PutBucketLoggingInput) (*request.Request, *s3.PutBucketLoggingOutput)
181189
+36
-0
service/s3/statusok_error.go less more
0 package s3
1
2 import (
3 "bytes"
4 "io/ioutil"
5 "net/http"
6
7 "github.com/aws/aws-sdk-go/aws"
8 "github.com/aws/aws-sdk-go/aws/awserr"
9 "github.com/aws/aws-sdk-go/aws/request"
10 )
11
12 func copyMultipartStatusOKUnmarhsalError(r *request.Request) {
13 b, err := ioutil.ReadAll(r.HTTPResponse.Body)
14 if err != nil {
15 r.Error = awserr.New("SerializationError", "unable to read response body", err)
16 return
17 }
18 body := bytes.NewReader(b)
19 r.HTTPResponse.Body = aws.ReadSeekCloser(body)
20 defer r.HTTPResponse.Body.(aws.ReaderSeekerCloser).Seek(0, 0)
21
22 if body.Len() == 0 {
23 // If there is no body don't attempt to parse the body.
24 return
25 }
26
27 unmarshalError(r)
28 if err, ok := r.Error.(awserr.Error); ok && err != nil {
29 if err.Code() == "SerializationError" {
30 r.Error = nil
31 return
32 }
33 r.HTTPResponse.StatusCode = http.StatusServiceUnavailable
34 }
35 }
+129
-0
service/s3/statusok_error_test.go less more
0 package s3_test
1
2 import (
3 "net/http"
4 "net/http/httptest"
5 "testing"
6
7 "github.com/stretchr/testify/assert"
8 "github.com/stretchr/testify/require"
9
10 "fmt"
11 "github.com/aws/aws-sdk-go/aws"
12 "github.com/aws/aws-sdk-go/aws/awserr"
13 "github.com/aws/aws-sdk-go/service/s3"
14 "time"
15 )
16
17 const errMsg = `<Error><Code>ErrorCode</Code><Message>message body</Message><RequestId>requestID</RequestId><HostId>hostID=</HostId></Error>`
18
19 var lastModifiedTime = time.Date(2009, 11, 23, 0, 0, 0, 0, time.UTC)
20
21 func TestCopyObjectNoError(t *testing.T) {
22 const successMsg = `
23 <?xml version="1.0" encoding="UTF-8"?>
24 <CopyObjectResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><LastModified>2009-11-23T0:00:00Z</LastModified><ETag>&quot;1da64c7f13d1e8dbeaea40b905fd586c&quot;</ETag></CopyObjectResult>`
25
26 res, err := newCopyTestSvc(successMsg).CopyObject(&s3.CopyObjectInput{
27 Bucket: aws.String("bucketname"),
28 CopySource: aws.String("bucketname/exists.txt"),
29 Key: aws.String("destination.txt"),
30 })
31
32 require.NoError(t, err)
33
34 assert.Equal(t, fmt.Sprintf(`%q`, "1da64c7f13d1e8dbeaea40b905fd586c"), *res.CopyObjectResult.ETag)
35 assert.Equal(t, lastModifiedTime, *res.CopyObjectResult.LastModified)
36 }
37
38 func TestCopyObjectError(t *testing.T) {
39 _, err := newCopyTestSvc(errMsg).CopyObject(&s3.CopyObjectInput{
40 Bucket: aws.String("bucketname"),
41 CopySource: aws.String("bucketname/doesnotexist.txt"),
42 Key: aws.String("destination.txt"),
43 })
44
45 require.Error(t, err)
46 e := err.(awserr.Error)
47
48 assert.Equal(t, "ErrorCode", e.Code())
49 assert.Equal(t, "message body", e.Message())
50 }
51
52 func TestUploadPartCopySuccess(t *testing.T) {
53 const successMsg = `
54 <?xml version="1.0" encoding="UTF-8"?>
55 <UploadPartCopyResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><LastModified>2009-11-23T0:00:00Z</LastModified><ETag>&quot;1da64c7f13d1e8dbeaea40b905fd586c&quot;</ETag></CopyObjectResult>`
56
57 res, err := newCopyTestSvc(successMsg).UploadPartCopy(&s3.UploadPartCopyInput{
58 Bucket: aws.String("bucketname"),
59 CopySource: aws.String("bucketname/doesnotexist.txt"),
60 Key: aws.String("destination.txt"),
61 PartNumber: aws.Int64(0),
62 UploadId: aws.String("uploadID"),
63 })
64
65 require.NoError(t, err)
66
67 assert.Equal(t, fmt.Sprintf(`%q`, "1da64c7f13d1e8dbeaea40b905fd586c"), *res.CopyPartResult.ETag)
68 assert.Equal(t, lastModifiedTime, *res.CopyPartResult.LastModified)
69 }
70
71 func TestUploadPartCopyError(t *testing.T) {
72 _, err := newCopyTestSvc(errMsg).UploadPartCopy(&s3.UploadPartCopyInput{
73 Bucket: aws.String("bucketname"),
74 CopySource: aws.String("bucketname/doesnotexist.txt"),
75 Key: aws.String("destination.txt"),
76 PartNumber: aws.Int64(0),
77 UploadId: aws.String("uploadID"),
78 })
79
80 require.Error(t, err)
81 e := err.(awserr.Error)
82
83 assert.Equal(t, "ErrorCode", e.Code())
84 assert.Equal(t, "message body", e.Message())
85 }
86
87 func TestCompleteMultipartUploadSuccess(t *testing.T) {
88 const successMsg = `
89 <?xml version="1.0" encoding="UTF-8"?>
90 <CompleteMultipartUploadResult xmlns="http://s3.amazonaws.com/doc/2006-03-01/"><Location>locationName</Location><Bucket>bucketName</Bucket><Key>keyName</Key><ETag>"etagVal"</ETag></CompleteMultipartUploadResult>`
91 res, err := newCopyTestSvc(successMsg).CompleteMultipartUpload(&s3.CompleteMultipartUploadInput{
92 Bucket: aws.String("bucketname"),
93 Key: aws.String("key"),
94 UploadId: aws.String("uploadID"),
95 })
96
97 require.NoError(t, err)
98
99 assert.Equal(t, `"etagVal"`, *res.ETag)
100 assert.Equal(t, "bucketName", *res.Bucket)
101 assert.Equal(t, "keyName", *res.Key)
102 assert.Equal(t, "locationName", *res.Location)
103 }
104
105 func TestCompleteMultipartUploadError(t *testing.T) {
106 _, err := newCopyTestSvc(errMsg).CompleteMultipartUpload(&s3.CompleteMultipartUploadInput{
107 Bucket: aws.String("bucketname"),
108 Key: aws.String("key"),
109 UploadId: aws.String("uploadID"),
110 })
111
112 require.Error(t, err)
113 e := err.(awserr.Error)
114
115 assert.Equal(t, "ErrorCode", e.Code())
116 assert.Equal(t, "message body", e.Message())
117 }
118
119 func newCopyTestSvc(errMsg string) *s3.S3 {
120 server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
121 http.Error(w, errMsg, http.StatusOK)
122 }))
123 return s3.New(aws.NewConfig().
124 WithEndpoint(server.URL).
125 WithDisableSSL(true).
126 WithMaxRetries(0).
127 WithS3ForcePathStyle(true))
128 }
+3
-3
service/ses/api.go less more
928928 Identity *string `type:"string" required:"true"`
929929
930930 // The name of the policy to be deleted.
931 PolicyName *string `type:"string" required:"true"`
931 PolicyName *string `min:"1" type:"string" required:"true"`
932932
933933 metadataDeleteIdentityPolicyInput `json:"-" xml:"-"`
934934 }
16241624 //
16251625 // For information about the syntax of sending authorization policies, see
16261626 // the Amazon SES Developer Guide (http://docs.aws.amazon.com/ses/latest/DeveloperGuide/sending-authorization-policies.html).
1627 Policy *string `type:"string" required:"true"`
1627 Policy *string `min:"1" type:"string" required:"true"`
16281628
16291629 // The name of the policy.
16301630 //
16311631 // The policy name cannot exceed 64 characters and can only include alphanumeric
16321632 // characters, dashes, and underscores.
1633 PolicyName *string `type:"string" required:"true"`
1633 PolicyName *string `min:"1" type:"string" required:"true"`
16341634
16351635 metadataPutIdentityPolicyInput `json:"-" xml:"-"`
16361636 }
+45
-45
service/ssm/api.go less more
338338 // Describes an association of a configuration document and an instance.
339339 type Association struct {
340340 // The ID of the instance.
341 InstanceId *string `type:"string"`
342
343 // The name of the configuration document.
344 Name *string `type:"string"`
341 InstanceId *string `min:"10" type:"string"`
342
343 // The name of the configuration document.
344 Name *string `min:"3" type:"string"`
345345
346346 metadataAssociation `json:"-" xml:"-"`
347347 }
366366 Date *time.Time `type:"timestamp" timestampFormat:"unix"`
367367
368368 // The ID of the instance.
369 InstanceId *string `type:"string"`
370
371 // The name of the configuration document.
372 Name *string `type:"string"`
369 InstanceId *string `min:"10" type:"string"`
370
371 // The name of the configuration document.
372 Name *string `min:"3" type:"string"`
373373
374374 // The association status.
375375 Status *AssociationStatus `type:"structure"`
397397 Key *string `locationName:"key" type:"string" required:"true" enum:"AssociationFilterKey"`
398398
399399 // The filter value.
400 Value *string `locationName:"value" type:"string" required:"true"`
400 Value *string `locationName:"value" min:"1" type:"string" required:"true"`
401401
402402 metadataAssociationFilter `json:"-" xml:"-"`
403403 }
495495 // Describes the association of a configuration document and an instance.
496496 type CreateAssociationBatchRequestEntry struct {
497497 // The ID of the instance.
498 InstanceId *string `type:"string"`
499
500 // The name of the configuration document.
501 Name *string `type:"string"`
498 InstanceId *string `min:"10" type:"string"`
499
500 // The name of the configuration document.
501 Name *string `min:"3" type:"string"`
502502
503503 metadataCreateAssociationBatchRequestEntry `json:"-" xml:"-"`
504504 }
519519
520520 type CreateAssociationInput struct {
521521 // The ID of the instance.
522 InstanceId *string `type:"string" required:"true"`
523
524 // The name of the configuration document.
525 Name *string `type:"string" required:"true"`
522 InstanceId *string `min:"10" type:"string" required:"true"`
523
524 // The name of the configuration document.
525 Name *string `min:"3" type:"string" required:"true"`
526526
527527 metadataCreateAssociationInput `json:"-" xml:"-"`
528528 }
565565 type CreateDocumentInput struct {
566566 // A valid JSON file. For more information about the contents of this file,
567567 // see Configuration Document (http://docs.aws.amazon.com/ssm/latest/APIReference/aws-ssm-document.html).
568 Content *string `type:"string" required:"true"`
568 Content *string `min:"1" type:"string" required:"true"`
569569
570570 // A name for the configuration document.
571 Name *string `type:"string" required:"true"`
571 Name *string `min:"3" type:"string" required:"true"`
572572
573573 metadataCreateDocumentInput `json:"-" xml:"-"`
574574 }
610610
611611 type DeleteAssociationInput struct {
612612 // The ID of the instance.
613 InstanceId *string `type:"string" required:"true"`
614
615 // The name of the configuration document.
616 Name *string `type:"string" required:"true"`
613 InstanceId *string `min:"10" type:"string" required:"true"`
614
615 // The name of the configuration document.
616 Name *string `min:"3" type:"string" required:"true"`
617617
618618 metadataDeleteAssociationInput `json:"-" xml:"-"`
619619 }
652652
653653 type DeleteDocumentInput struct {
654654 // The name of the configuration document.
655 Name *string `type:"string" required:"true"`
655 Name *string `min:"3" type:"string" required:"true"`
656656
657657 metadataDeleteDocumentInput `json:"-" xml:"-"`
658658 }
691691
692692 type DescribeAssociationInput struct {
693693 // The ID of the instance.
694 InstanceId *string `type:"string" required:"true"`
695
696 // The name of the configuration document.
697 Name *string `type:"string" required:"true"`
694 InstanceId *string `min:"10" type:"string" required:"true"`
695
696 // The name of the configuration document.
697 Name *string `min:"3" type:"string" required:"true"`
698698
699699 metadataDescribeAssociationInput `json:"-" xml:"-"`
700700 }
736736
737737 type DescribeDocumentInput struct {
738738 // The name of the configuration document.
739 Name *string `type:"string" required:"true"`
739 Name *string `min:"3" type:"string" required:"true"`
740740
741741 metadataDescribeDocumentInput `json:"-" xml:"-"`
742742 }
782782 CreatedDate *time.Time `type:"timestamp" timestampFormat:"unix"`
783783
784784 // The name of the configuration document.
785 Name *string `type:"string"`
785 Name *string `min:"3" type:"string"`
786786
787787 // The SHA1 hash of the document, which you can use for verification purposes.
788788 Sha1 *string `type:"string"`
813813 Key *string `locationName:"key" type:"string" required:"true" enum:"DocumentFilterKey"`
814814
815815 // The value of the filter.
816 Value *string `locationName:"value" type:"string" required:"true"`
816 Value *string `locationName:"value" min:"1" type:"string" required:"true"`
817817
818818 metadataDocumentFilter `json:"-" xml:"-"`
819819 }
835835 // Describes the name of a configuration document.
836836 type DocumentIdentifier struct {
837837 // The name of the configuration document.
838 Name *string `type:"string"`
838 Name *string `min:"3" type:"string"`
839839
840840 metadataDocumentIdentifier `json:"-" xml:"-"`
841841 }
884884
885885 type GetDocumentInput struct {
886886 // The name of the configuration document.
887 Name *string `type:"string" required:"true"`
887 Name *string `min:"3" type:"string" required:"true"`
888888
889889 metadataGetDocumentInput `json:"-" xml:"-"`
890890 }
905905
906906 type GetDocumentOutput struct {
907907 // The contents of the configuration document.
908 Content *string `type:"string"`
909
910 // The name of the configuration document.
911 Name *string `type:"string"`
908 Content *string `min:"1" type:"string"`
909
910 // The name of the configuration document.
911 Name *string `min:"3" type:"string"`
912912
913913 metadataGetDocumentOutput `json:"-" xml:"-"`
914914 }
929929
930930 type ListAssociationsInput struct {
931931 // One or more filters. Use a filter to return a more specific list of results.
932 AssociationFilterList []*AssociationFilter `locationNameList:"AssociationFilter" type:"list" required:"true"`
932 AssociationFilterList []*AssociationFilter `locationNameList:"AssociationFilter" min:"1" type:"list" required:"true"`
933933
934934 // The maximum number of items to return for this call. The call also returns
935935 // a token that you can specify in a subsequent call to get the next set of
936936 // results.
937 MaxResults *int64 `type:"integer"`
937 MaxResults *int64 `min:"1" type:"integer"`
938938
939939 // The token for the next set of items to return. (You received this token from
940940 // a previous call.)
984984
985985 type ListDocumentsInput struct {
986986 // One or more filters. Use a filter to return a more specific list of results.
987 DocumentFilterList []*DocumentFilter `locationNameList:"DocumentFilter" type:"list"`
987 DocumentFilterList []*DocumentFilter `locationNameList:"DocumentFilter" min:"1" type:"list"`
988988
989989 // The maximum number of items to return for this call. The call also returns
990990 // a token that you can specify in a subsequent call to get the next set of
991991 // results.
992 MaxResults *int64 `type:"integer"`
992 MaxResults *int64 `min:"1" type:"integer"`
993993
994994 // The token for the next set of items to return. (You received this token from
995995 // a previous call.)
10421042 AssociationStatus *AssociationStatus `type:"structure" required:"true"`
10431043
10441044 // The ID of the instance.
1045 InstanceId *string `type:"string" required:"true"`
1046
1047 // The name of the configuration document.
1048 Name *string `type:"string" required:"true"`
1045 InstanceId *string `min:"10" type:"string" required:"true"`
1046
1047 // The name of the configuration document.
1048 Name *string `min:"3" type:"string" required:"true"`
10491049
10501050 metadataUpdateAssociationStatusInput `json:"-" xml:"-"`
10511051 }
+225
-225
service/storagegateway/api.go less more
18731873 // also include other activation-related parameters, however, these are merely
18741874 // defaults -- the arguments you pass to the ActivateGateway API call determine
18751875 // the actual configuration of your gateway.
1876 ActivationKey *string `type:"string" required:"true"`
1876 ActivationKey *string `min:"1" type:"string" required:"true"`
18771877
18781878 // A unique identifier for your gateway. This name becomes part of the gateway
18791879 // Amazon Resources Name (ARN) which is what you use as an input to other operations.
1880 GatewayName *string `type:"string" required:"true"`
1880 GatewayName *string `min:"2" type:"string" required:"true"`
18811881
18821882 // One of the values that indicates the region where you want to store the snapshot
18831883 // backups. The gateway region specified must be the same region as the region
18881888 //
18891889 // Valid Values: "us-east-1", "us-west-1", "us-west-2", "eu-west-1", "eu-central-1",
18901890 // "ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "sa-east-1"
1891 GatewayRegion *string `type:"string" required:"true"`
1891 GatewayRegion *string `min:"1" type:"string" required:"true"`
18921892
18931893 // One of the values that indicates the time zone you want to set for the gateway.
18941894 // The time zone is used, for example, for scheduling snapshots and your gateway's
18951895 // maintenance schedule.
1896 GatewayTimezone *string `type:"string" required:"true"`
1896 GatewayTimezone *string `min:"3" type:"string" required:"true"`
18971897
18981898 // One of the values that defines the type of gateway to activate. The type
18991899 // specified is critical to all later functions of the gateway and cannot be
19001900 // changed after activation. The default value is STORED.
1901 GatewayType *string `type:"string"`
1901 GatewayType *string `min:"2" type:"string"`
19021902
19031903 // The value that indicates the type of medium changer to use for gateway-VTL.
19041904 // This field is optional.
19051905 //
19061906 // Valid Values: "STK-L700", "AWS-Gateway-VTL"
1907 MediumChangerType *string `type:"string"`
1907 MediumChangerType *string `min:"2" type:"string"`
19081908
19091909 // The value that indicates the type of tape drive to use for gateway-VTL. This
19101910 // field is optional.
19111911 //
19121912 // Valid Values: "IBM-ULT3580-TD5"
1913 TapeDriveType *string `type:"string"`
1913 TapeDriveType *string `min:"2" type:"string"`
19141914
19151915 metadataActivateGatewayInput `json:"-" xml:"-"`
19161916 }
19361936 type ActivateGatewayOutput struct {
19371937 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
19381938 // to return a list of gateways for your account and region.
1939 GatewayARN *string `type:"string"`
1939 GatewayARN *string `min:"50" type:"string"`
19401940
19411941 metadataActivateGatewayOutput `json:"-" xml:"-"`
19421942 }
19601960
19611961 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
19621962 // to return a list of gateways for your account and region.
1963 GatewayARN *string `type:"string" required:"true"`
1963 GatewayARN *string `min:"50" type:"string" required:"true"`
19641964
19651965 metadataAddCacheInput `json:"-" xml:"-"`
19661966 }
19821982 type AddCacheOutput struct {
19831983 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
19841984 // to return a list of gateways for your account and region.
1985 GatewayARN *string `type:"string"`
1985 GatewayARN *string `min:"50" type:"string"`
19861986
19871987 metadataAddCacheOutput `json:"-" xml:"-"`
19881988 }
20042004 // AddTagsToResourceInput
20052005 type AddTagsToResourceInput struct {
20062006 // The Amazon Resource Name (ARN) of the resource you want to add tags to.
2007 ResourceARN *string `type:"string" required:"true"`
2007 ResourceARN *string `min:"50" type:"string" required:"true"`
20082008
20092009 // The key-value pair that represents the tag you want to add to the resource.
20102010 // The value can be an empty string.
20332033 // AddTagsToResourceOutput
20342034 type AddTagsToResourceOutput struct {
20352035 // The Amazon Resource Name (ARN) of the resource you want to add tags to.
2036 ResourceARN *string `type:"string"`
2036 ResourceARN *string `min:"50" type:"string"`
20372037
20382038 metadataAddTagsToResourceOutput `json:"-" xml:"-"`
20392039 }
20572057
20582058 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
20592059 // to return a list of gateways for your account and region.
2060 GatewayARN *string `type:"string" required:"true"`
2060 GatewayARN *string `min:"50" type:"string" required:"true"`
20612061
20622062 metadataAddUploadBufferInput `json:"-" xml:"-"`
20632063 }
20792079 type AddUploadBufferOutput struct {
20802080 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
20812081 // to return a list of gateways for your account and region.
2082 GatewayARN *string `type:"string"`
2082 GatewayARN *string `min:"50" type:"string"`
20832083
20842084 metadataAddUploadBufferOutput `json:"-" xml:"-"`
20852085 }
21092109
21102110 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
21112111 // to return a list of gateways for your account and region.
2112 GatewayARN *string `type:"string" required:"true"`
2112 GatewayARN *string `min:"50" type:"string" required:"true"`
21132113
21142114 metadataAddWorkingStorageInput `json:"-" xml:"-"`
21152115 }
21332133 type AddWorkingStorageOutput struct {
21342134 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
21352135 // to return a list of gateways for your account and region.
2136 GatewayARN *string `type:"string"`
2136 GatewayARN *string `min:"50" type:"string"`
21372137
21382138 metadataAddWorkingStorageOutput `json:"-" xml:"-"`
21392139 }
21552155 type CachediSCSIVolume struct {
21562156 SourceSnapshotId *string `type:"string"`
21572157
2158 VolumeARN *string `type:"string"`
2159
2160 VolumeId *string `type:"string"`
2158 VolumeARN *string `min:"50" type:"string"`
2159
2160 VolumeId *string `min:"12" type:"string"`
21612161
21622162 VolumeProgress *float64 `type:"double"`
21632163
21642164 VolumeSizeInBytes *int64 `type:"long"`
21652165
2166 VolumeStatus *string `type:"string"`
2167
2168 VolumeType *string `type:"string"`
2166 VolumeStatus *string `min:"3" type:"string"`
2167
2168 VolumeType *string `min:"3" type:"string"`
21692169
21702170 // Lists iSCSI information about a volume.
21712171 VolumeiSCSIAttributes *VolumeiSCSIAttributes `type:"structure"`
21912191 type CancelArchivalInput struct {
21922192 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
21932193 // to return a list of gateways for your account and region.
2194 GatewayARN *string `type:"string" required:"true"`
2194 GatewayARN *string `min:"50" type:"string" required:"true"`
21952195
21962196 // The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving
21972197 // for.
2198 TapeARN *string `type:"string" required:"true"`
2198 TapeARN *string `min:"50" type:"string" required:"true"`
21992199
22002200 metadataCancelArchivalInput `json:"-" xml:"-"`
22012201 }
22182218 type CancelArchivalOutput struct {
22192219 // The Amazon Resource Name (ARN) of the virtual tape for which archiving was
22202220 // canceled.
2221 TapeARN *string `type:"string"`
2221 TapeARN *string `min:"50" type:"string"`
22222222
22232223 metadataCancelArchivalOutput `json:"-" xml:"-"`
22242224 }
22412241 type CancelRetrievalInput struct {
22422242 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
22432243 // to return a list of gateways for your account and region.
2244 GatewayARN *string `type:"string" required:"true"`
2244 GatewayARN *string `min:"50" type:"string" required:"true"`
22452245
22462246 // The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval
22472247 // for.
2248 TapeARN *string `type:"string" required:"true"`
2248 TapeARN *string `min:"50" type:"string" required:"true"`
22492249
22502250 metadataCancelRetrievalInput `json:"-" xml:"-"`
22512251 }
22682268 type CancelRetrievalOutput struct {
22692269 // The Amazon Resource Name (ARN) of the virtual tape for which retrieval was
22702270 // canceled.
2271 TapeARN *string `type:"string"`
2271 TapeARN *string `min:"50" type:"string"`
22722272
22732273 metadataCancelRetrievalOutput `json:"-" xml:"-"`
22742274 }
22912291 // that supports authentication between your gateway and iSCSI initiators.
22922292 type ChapInfo struct {
22932293 // The iSCSI initiator that connects to the target.
2294 InitiatorName *string `type:"string"`
2294 InitiatorName *string `min:"1" type:"string"`
22952295
22962296 // The secret key that the initiator (for example, the Windows client) must
22972297 // provide to participate in mutual CHAP with the target.
2298 SecretToAuthenticateInitiator *string `type:"string"`
2298 SecretToAuthenticateInitiator *string `min:"1" type:"string"`
22992299
23002300 // The secret key that the target must provide to participate in mutual CHAP
23012301 // with the initiator (e.g. Windows client).
2302 SecretToAuthenticateTarget *string `type:"string"`
2302 SecretToAuthenticateTarget *string `min:"1" type:"string"`
23032303
23042304 // The Amazon Resource Name (ARN) of the volume.
23052305 //
23062306 // Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens
23072307 // (-).
2308 TargetARN *string `type:"string"`
2308 TargetARN *string `min:"50" type:"string"`
23092309
23102310 metadataChapInfo `json:"-" xml:"-"`
23112311 }
23252325 }
23262326
23272327 type CreateCachediSCSIVolumeInput struct {
2328 ClientToken *string `type:"string" required:"true"`
2329
2330 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2331 // to return a list of gateways for your account and region.
2332 GatewayARN *string `type:"string" required:"true"`
2328 ClientToken *string `min:"5" type:"string" required:"true"`
2329
2330 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2331 // to return a list of gateways for your account and region.
2332 GatewayARN *string `min:"50" type:"string" required:"true"`
23332333
23342334 NetworkInterfaceId *string `type:"string" required:"true"`
23352335
23362336 SnapshotId *string `type:"string"`
23372337
2338 TargetName *string `type:"string" required:"true"`
2338 TargetName *string `min:"1" type:"string" required:"true"`
23392339
23402340 VolumeSizeInBytes *int64 `type:"long" required:"true"`
23412341
23572357 }
23582358
23592359 type CreateCachediSCSIVolumeOutput struct {
2360 TargetARN *string `type:"string"`
2361
2362 VolumeARN *string `type:"string"`
2360 TargetARN *string `min:"50" type:"string"`
2361
2362 VolumeARN *string `min:"50" type:"string"`
23632363
23642364 metadataCreateCachediSCSIVolumeOutput `json:"-" xml:"-"`
23652365 }
23792379 }
23802380
23812381 type CreateSnapshotFromVolumeRecoveryPointInput struct {
2382 SnapshotDescription *string `type:"string" required:"true"`
2383
2384 VolumeARN *string `type:"string" required:"true"`
2382 SnapshotDescription *string `min:"1" type:"string" required:"true"`
2383
2384 VolumeARN *string `min:"50" type:"string" required:"true"`
23852385
23862386 metadataCreateSnapshotFromVolumeRecoveryPointInput `json:"-" xml:"-"`
23872387 }
24032403 type CreateSnapshotFromVolumeRecoveryPointOutput struct {
24042404 SnapshotId *string `type:"string"`
24052405
2406 VolumeARN *string `type:"string"`
2406 VolumeARN *string `min:"50" type:"string"`
24072407
24082408 VolumeRecoveryPointTime *string `type:"string"`
24092409
24312431 // Textual description of the snapshot that appears in the Amazon EC2 console,
24322432 // Elastic Block Store snapshots panel in the Description field, and in the
24332433 // AWS Storage Gateway snapshot Details pane, Description field
2434 SnapshotDescription *string `type:"string" required:"true"`
2434 SnapshotDescription *string `min:"1" type:"string" required:"true"`
24352435
24362436 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
24372437 // to return a list of gateway volumes.
2438 VolumeARN *string `type:"string" required:"true"`
2438 VolumeARN *string `min:"50" type:"string" required:"true"`
24392439
24402440 metadataCreateSnapshotInput `json:"-" xml:"-"`
24412441 }
24622462 SnapshotId *string `type:"string"`
24632463
24642464 // The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.
2465 VolumeARN *string `type:"string"`
2465 VolumeARN *string `min:"50" type:"string"`
24662466
24672467 metadataCreateSnapshotOutput `json:"-" xml:"-"`
24682468 }
24902490 // The unique identifier for the gateway local disk that is configured as a
24912491 // stored volume. Use ListLocalDisks (http://docs.aws.amazon.com/storagegateway/latest/userguide/API_ListLocalDisks.html)
24922492 // to list disk IDs for a gateway.
2493 DiskId *string `type:"string" required:"true"`
2494
2495 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2496 // to return a list of gateways for your account and region.
2497 GatewayARN *string `type:"string" required:"true"`
2493 DiskId *string `min:"1" type:"string" required:"true"`
2494
2495 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2496 // to return a list of gateways for your account and region.
2497 GatewayARN *string `min:"50" type:"string" required:"true"`
24982498
24992499 // The network interface of the gateway on which to expose the iSCSI target.
25002500 // Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a
25202520 // and as a suffix for the target ARN. For example, specifying TargetName as
25212521 // myvolume results in the target ARN of arn:aws:storagegateway:us-east-1:111122223333:gateway/mygateway/target/iqn.1997-05.com.amazon:myvolume.
25222522 // The target name must be unique across all volumes of a gateway.
2523 TargetName *string `type:"string" required:"true"`
2523 TargetName *string `min:"1" type:"string" required:"true"`
25242524
25252525 metadataCreateStorediSCSIVolumeInput `json:"-" xml:"-"`
25262526 }
25432543 type CreateStorediSCSIVolumeOutput struct {
25442544 // he Amazon Resource Name (ARN) of the volume target that includes the iSCSI
25452545 // name that initiators can use to connect to the target.
2546 TargetARN *string `type:"string"`
2546 TargetARN *string `min:"50" type:"string"`
25472547
25482548 // The Amazon Resource Name (ARN) of the configured volume.
2549 VolumeARN *string `type:"string"`
2549 VolumeARN *string `min:"50" type:"string"`
25502550
25512551 // The size of the volume in bytes.
25522552 VolumeSizeInBytes *int64 `type:"long"`
25742574 // use the same ClientToken you specified in the initial request.
25752575 //
25762576 // Using the same ClientToken prevents creating the tape multiple times.
2577 ClientToken *string `type:"string" required:"true"`
2577 ClientToken *string `min:"5" type:"string" required:"true"`
25782578
25792579 // The unique Amazon Resource Name(ARN) that represents the gateway to associate
25802580 // the virtual tapes with. Use the ListGateways operation to return a list of
25812581 // gateways for your account and region.
2582 GatewayARN *string `type:"string" required:"true"`
2582 GatewayARN *string `min:"50" type:"string" required:"true"`
25832583
25842584 // The number of virtual tapes you want to create.
2585 NumTapesToCreate *int64 `type:"integer" required:"true"`
2585 NumTapesToCreate *int64 `min:"1" type:"integer" required:"true"`
25862586
25872587 // A prefix you append to the barcode of the virtual tape you are creating.
25882588 // This makes a barcode unique.
25892589 //
25902590 // The prefix must be 1 to 4 characters in length and must be upper-case letters
25912591 // A-Z.
2592 TapeBarcodePrefix *string `type:"string" required:"true"`
2592 TapeBarcodePrefix *string `min:"1" type:"string" required:"true"`
25932593
25942594 // The size, in bytes, of the virtual tapes you want to create.
25952595 //
26372637 }
26382638
26392639 type DeleteBandwidthRateLimitInput struct {
2640 BandwidthType *string `type:"string" required:"true"`
2641
2642 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2643 // to return a list of gateways for your account and region.
2644 GatewayARN *string `type:"string" required:"true"`
2640 BandwidthType *string `min:"3" type:"string" required:"true"`
2641
2642 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
2643 // to return a list of gateways for your account and region.
2644 GatewayARN *string `min:"50" type:"string" required:"true"`
26452645
26462646 metadataDeleteBandwidthRateLimitInput `json:"-" xml:"-"`
26472647 }
26652665 type DeleteBandwidthRateLimitOutput struct {
26662666 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
26672667 // to return a list of gateways for your account and region.
2668 GatewayARN *string `type:"string"`
2668 GatewayARN *string `min:"50" type:"string"`
26692669
26702670 metadataDeleteBandwidthRateLimitOutput `json:"-" xml:"-"`
26712671 }
26892689 // DeleteChapCredentialsInput$InitiatorName DeleteChapCredentialsInput$TargetARN
26902690 type DeleteChapCredentialsInput struct {
26912691 // The iSCSI initiator that connects to the target.
2692 InitiatorName *string `type:"string" required:"true"`
2692 InitiatorName *string `min:"1" type:"string" required:"true"`
26932693
26942694 // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
26952695 // operation to return to retrieve the TargetARN for specified VolumeARN.
2696 TargetARN *string `type:"string" required:"true"`
2696 TargetARN *string `min:"50" type:"string" required:"true"`
26972697
26982698 metadataDeleteChapCredentialsInput `json:"-" xml:"-"`
26992699 }
27152715 // A JSON object containing the following fields:
27162716 type DeleteChapCredentialsOutput struct {
27172717 // The iSCSI initiator that connects to the target.
2718 InitiatorName *string `type:"string"`
2718 InitiatorName *string `min:"1" type:"string"`
27192719
27202720 // The Amazon Resource Name (ARN) of the target.
2721 TargetARN *string `type:"string"`
2721 TargetARN *string `min:"50" type:"string"`
27222722
27232723 metadataDeleteChapCredentialsOutput `json:"-" xml:"-"`
27242724 }
27412741 type DeleteGatewayInput struct {
27422742 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
27432743 // to return a list of gateways for your account and region.
2744 GatewayARN *string `type:"string" required:"true"`
2744 GatewayARN *string `min:"50" type:"string" required:"true"`
27452745
27462746 metadataDeleteGatewayInput `json:"-" xml:"-"`
27472747 }
27642764 type DeleteGatewayOutput struct {
27652765 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
27662766 // to return a list of gateways for your account and region.
2767 GatewayARN *string `type:"string"`
2767 GatewayARN *string `min:"50" type:"string"`
27682768
27692769 metadataDeleteGatewayOutput `json:"-" xml:"-"`
27702770 }
27842784 }
27852785
27862786 type DeleteSnapshotScheduleInput struct {
2787 VolumeARN *string `type:"string" required:"true"`
2787 VolumeARN *string `min:"50" type:"string" required:"true"`
27882788
27892789 metadataDeleteSnapshotScheduleInput `json:"-" xml:"-"`
27902790 }
28042804 }
28052805
28062806 type DeleteSnapshotScheduleOutput struct {
2807 VolumeARN *string `type:"string"`
2807 VolumeARN *string `min:"50" type:"string"`
28082808
28092809 metadataDeleteSnapshotScheduleOutput `json:"-" xml:"-"`
28102810 }
28272827 type DeleteTapeArchiveInput struct {
28282828 // The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual
28292829 // tape shelf (VTS).
2830 TapeARN *string `type:"string" required:"true"`
2830 TapeARN *string `min:"50" type:"string" required:"true"`
28312831
28322832 metadataDeleteTapeArchiveInput `json:"-" xml:"-"`
28332833 }
28502850 type DeleteTapeArchiveOutput struct {
28512851 // The Amazon Resource Name (ARN) of the virtual tape that was deleted from
28522852 // the virtual tape shelf (VTS).
2853 TapeARN *string `type:"string"`
2853 TapeARN *string `min:"50" type:"string"`
28542854
28552855 metadataDeleteTapeArchiveOutput `json:"-" xml:"-"`
28562856 }
28742874 // The unique Amazon Resource Name (ARN) of the gateway that the virtual tape
28752875 // to delete is associated with. Use the ListGateways operation to return a
28762876 // list of gateways for your account and region.
2877 GatewayARN *string `type:"string" required:"true"`
2877 GatewayARN *string `min:"50" type:"string" required:"true"`
28782878
28792879 // The Amazon Resource Name (ARN) of the virtual tape to delete.
2880 TapeARN *string `type:"string" required:"true"`
2880 TapeARN *string `min:"50" type:"string" required:"true"`
28812881
28822882 metadataDeleteTapeInput `json:"-" xml:"-"`
28832883 }
28992899 // DeleteTapeOutput
29002900 type DeleteTapeOutput struct {
29012901 // The Amazon Resource Name (ARN) of the deleted virtual tape.
2902 TapeARN *string `type:"string"`
2902 TapeARN *string `min:"50" type:"string"`
29032903
29042904 metadataDeleteTapeOutput `json:"-" xml:"-"`
29052905 }
29222922 type DeleteVolumeInput struct {
29232923 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
29242924 // to return a list of gateway volumes.
2925 VolumeARN *string `type:"string" required:"true"`
2925 VolumeARN *string `min:"50" type:"string" required:"true"`
29262926
29272927 metadataDeleteVolumeInput `json:"-" xml:"-"`
29282928 }
29452945 type DeleteVolumeOutput struct {
29462946 // The Amazon Resource Name (ARN) of the storage volume that was deleted. It
29472947 // is the same ARN you provided in the request.
2948 VolumeARN *string `type:"string"`
2948 VolumeARN *string `min:"50" type:"string"`
29492949
29502950 metadataDeleteVolumeOutput `json:"-" xml:"-"`
29512951 }
29682968 type DescribeBandwidthRateLimitInput struct {
29692969 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
29702970 // to return a list of gateways for your account and region.
2971 GatewayARN *string `type:"string" required:"true"`
2971 GatewayARN *string `min:"50" type:"string" required:"true"`
29722972
29732973 metadataDescribeBandwidthRateLimitInput `json:"-" xml:"-"`
29742974 }
29912991 type DescribeBandwidthRateLimitOutput struct {
29922992 // The average download bandwidth rate limit in bits per second. This field
29932993 // does not appear in the response if the download rate limit is not set.
2994 AverageDownloadRateLimitInBitsPerSec *int64 `type:"long"`
2994 AverageDownloadRateLimitInBitsPerSec *int64 `min:"102400" type:"long"`
29952995
29962996 // The average upload bandwidth rate limit in bits per second. This field does
29972997 // not appear in the response if the upload rate limit is not set.
2998 AverageUploadRateLimitInBitsPerSec *int64 `type:"long"`
2999
3000 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
3001 // to return a list of gateways for your account and region.
3002 GatewayARN *string `type:"string"`
2998 AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`
2999
3000 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
3001 // to return a list of gateways for your account and region.
3002 GatewayARN *string `min:"50" type:"string"`
30033003
30043004 metadataDescribeBandwidthRateLimitOutput `json:"-" xml:"-"`
30053005 }
30213021 type DescribeCacheInput struct {
30223022 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
30233023 // to return a list of gateways for your account and region.
3024 GatewayARN *string `type:"string" required:"true"`
3024 GatewayARN *string `min:"50" type:"string" required:"true"`
30253025
30263026 metadataDescribeCacheInput `json:"-" xml:"-"`
30273027 }
30553055
30563056 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
30573057 // to return a list of gateways for your account and region.
3058 GatewayARN *string `type:"string"`
3058 GatewayARN *string `min:"50" type:"string"`
30593059
30603060 metadataDescribeCacheOutput `json:"-" xml:"-"`
30613061 }
31223122 type DescribeChapCredentialsInput struct {
31233123 // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
31243124 // operation to return to retrieve the TargetARN for specified VolumeARN.
3125 TargetARN *string `type:"string" required:"true"`
3125 TargetARN *string `min:"50" type:"string" required:"true"`
31263126
31273127 metadataDescribeChapCredentialsInput `json:"-" xml:"-"`
31283128 }
31813181 type DescribeGatewayInformationInput struct {
31823182 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
31833183 // to return a list of gateways for your account and region.
3184 GatewayARN *string `type:"string" required:"true"`
3184 GatewayARN *string `min:"50" type:"string" required:"true"`
31853185
31863186 metadataDescribeGatewayInformationInput `json:"-" xml:"-"`
31873187 }
32043204 type DescribeGatewayInformationOutput struct {
32053205 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
32063206 // to return a list of gateways for your account and region.
3207 GatewayARN *string `type:"string"`
3207 GatewayARN *string `min:"50" type:"string"`
32083208
32093209 // The gateway ID.
3210 GatewayId *string `type:"string"`
3210 GatewayId *string `min:"12" type:"string"`
32113211
32123212 // The gateway name.
32133213 GatewayName *string `type:"string"`
32173217 GatewayNetworkInterfaces []*NetworkInterface `type:"list"`
32183218
32193219 // One of the values that indicates the operating state of the gateway.
3220 GatewayState *string `type:"string"`
3220 GatewayState *string `min:"2" type:"string"`
32213221
32223222 // One of the values that indicates the time zone configured for the gateway.
3223 GatewayTimezone *string `type:"string"`
3223 GatewayTimezone *string `min:"3" type:"string"`
32243224
32253225 // The type of the gateway.
3226 GatewayType *string `type:"string"`
3226 GatewayType *string `min:"2" type:"string"`
32273227
32283228 // The date on which the last software update was applied to the gateway. If
32293229 // the gateway has never been updated, this field does not return a value in
32303230 // the response.
3231 LastSoftwareUpdate *string `type:"string"`
3231 LastSoftwareUpdate *string `min:"1" type:"string"`
32323232
32333233 // The date on which an update to the gateway is available. This date is in
32343234 // the time zone of the gateway. If the gateway is not available for an update
32353235 // this field is not returned in the response.
3236 NextUpdateAvailabilityDate *string `type:"string"`
3236 NextUpdateAvailabilityDate *string `min:"1" type:"string"`
32373237
32383238 metadataDescribeGatewayInformationOutput `json:"-" xml:"-"`
32393239 }
32563256 type DescribeMaintenanceStartTimeInput struct {
32573257 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
32583258 // to return a list of gateways for your account and region.
3259 GatewayARN *string `type:"string" required:"true"`
3259 GatewayARN *string `min:"50" type:"string" required:"true"`
32603260
32613261 metadataDescribeMaintenanceStartTimeInput `json:"-" xml:"-"`
32623262 }
32803280
32813281 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
32823282 // to return a list of gateways for your account and region.
3283 GatewayARN *string `type:"string"`
3283 GatewayARN *string `min:"50" type:"string"`
32843284
32853285 HourOfDay *int64 `type:"integer"`
32863286
32873287 MinuteOfHour *int64 `type:"integer"`
32883288
3289 Timezone *string `type:"string"`
3289 Timezone *string `min:"3" type:"string"`
32903290
32913291 metadataDescribeMaintenanceStartTimeOutput `json:"-" xml:"-"`
32923292 }
33103310 type DescribeSnapshotScheduleInput struct {
33113311 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
33123312 // to return a list of gateway volumes.
3313 VolumeARN *string `type:"string" required:"true"`
3313 VolumeARN *string `min:"50" type:"string" required:"true"`
33143314
33153315 metadataDescribeSnapshotScheduleInput `json:"-" xml:"-"`
33163316 }
33303330 }
33313331
33323332 type DescribeSnapshotScheduleOutput struct {
3333 Description *string `type:"string"`
3334
3335 RecurrenceInHours *int64 `type:"integer"`
3333 Description *string `min:"1" type:"string"`
3334
3335 RecurrenceInHours *int64 `min:"1" type:"integer"`
33363336
33373337 StartAt *int64 `type:"integer"`
33383338
3339 Timezone *string `type:"string"`
3340
3341 VolumeARN *string `type:"string"`
3339 Timezone *string `min:"3" type:"string"`
3340
3341 VolumeARN *string `min:"50" type:"string"`
33423342
33433343 metadataDescribeSnapshotScheduleOutput `json:"-" xml:"-"`
33443344 }
34053405 type DescribeTapeArchivesInput struct {
34063406 // Specifies that the number of virtual tapes descried be limited to the specified
34073407 // number.
3408 Limit *int64 `type:"integer"`
3408 Limit *int64 `min:"1" type:"integer"`
34093409
34103410 // An opaque string that indicates the position at which to begin describing
34113411 // virtual tapes.
3412 Marker *string `type:"string"`
3412 Marker *string `min:"1" type:"string"`
34133413
34143414 // Specifies one or more unique Amazon Resource Names (ARNs) that represent
34153415 // the virtual tapes you want to describe.
34393439 // to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If
34403440 // there are no more virtual tapes to describe, this field does not appear in
34413441 // the response.
3442 Marker *string `type:"string"`
3442 Marker *string `min:"1" type:"string"`
34433443
34443444 // An array of virtual tape objects in the virtual tape shelf (VTS). The description
34453445 // includes of the Amazon Resource Name(ARN) of the virtual tapes. The information
34683468 type DescribeTapeRecoveryPointsInput struct {
34693469 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
34703470 // to return a list of gateways for your account and region.
3471 GatewayARN *string `type:"string" required:"true"`
3471 GatewayARN *string `min:"50" type:"string" required:"true"`
34723472
34733473 // Specifies that the number of virtual tape recovery points that are described
34743474 // be limited to the specified number.
3475 Limit *int64 `type:"integer"`
3475 Limit *int64 `min:"1" type:"integer"`
34763476
34773477 // An opaque string that indicates the position at which to begin describing
34783478 // the virtual tape recovery points.
3479 Marker *string `type:"string"`
3479 Marker *string `min:"1" type:"string"`
34803480
34813481 metadataDescribeTapeRecoveryPointsInput `json:"-" xml:"-"`
34823482 }
34993499 type DescribeTapeRecoveryPointsOutput struct {
35003500 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
35013501 // to return a list of gateways for your account and region.
3502 GatewayARN *string `type:"string"`
3502 GatewayARN *string `min:"50" type:"string"`
35033503
35043504 // An opaque string that indicates the position at which the virtual tape recovery
35053505 // points that were listed for description ended.
35073507 // Use this marker in your next request to list the next set of virtual tape
35083508 // recovery points in the list. If there are no more recovery points to describe,
35093509 // this field does not appear in the response.
3510 Marker *string `type:"string"`
3510 Marker *string `min:"1" type:"string"`
35113511
35123512 // An array of TapeRecoveryPointInfos that are available for the specified gateway.
35133513 TapeRecoveryPointInfos []*TapeRecoveryPointInfo `type:"list"`
35333533 type DescribeTapesInput struct {
35343534 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
35353535 // to return a list of gateways for your account and region.
3536 GatewayARN *string `type:"string" required:"true"`
3536 GatewayARN *string `min:"50" type:"string" required:"true"`
35373537
35383538 // Specifies that the number of virtual tapes described be limited to the specified
35393539 // number.
35403540 //
35413541 // Amazon Web Services may impose its own limit, if this field is not set.
3542 Limit *int64 `type:"integer"`
3542 Limit *int64 `min:"1" type:"integer"`
35433543
35443544 // A marker value, obtained in a previous call to DescribeTapes. This marker
35453545 // indicates which page of results to retrieve.
35463546 //
35473547 // If not specified, the first page of results is retrieved.
3548 Marker *string `type:"string"`
3548 Marker *string `min:"1" type:"string"`
35493549
35503550 // Specifies one or more unique Amazon Resource Names (ARNs) that represent
35513551 // the virtual tapes you want to describe. If this parameter is not specified,
35773577 //
35783578 // If a response does not contain a marker, then there are no more results
35793579 // to be retrieved.
3580 Marker *string `type:"string"`
3580 Marker *string `min:"1" type:"string"`
35813581
35823582 // An array of virtual tape descriptions.
35833583 Tapes []*Tape `type:"list"`
36023602 type DescribeUploadBufferInput struct {
36033603 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
36043604 // to return a list of gateways for your account and region.
3605 GatewayARN *string `type:"string" required:"true"`
3605 GatewayARN *string `min:"50" type:"string" required:"true"`
36063606
36073607 metadataDescribeUploadBufferInput `json:"-" xml:"-"`
36083608 }
36263626
36273627 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
36283628 // to return a list of gateways for your account and region.
3629 GatewayARN *string `type:"string"`
3629 GatewayARN *string `min:"50" type:"string"`
36303630
36313631 UploadBufferAllocatedInBytes *int64 `type:"long"`
36323632
36533653 type DescribeVTLDevicesInput struct {
36543654 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
36553655 // to return a list of gateways for your account and region.
3656 GatewayARN *string `type:"string" required:"true"`
3656 GatewayARN *string `min:"50" type:"string" required:"true"`
36573657
36583658 // Specifies that the number of VTL devices described be limited to the specified
36593659 // number.
3660 Limit *int64 `type:"integer"`
3660 Limit *int64 `min:"1" type:"integer"`
36613661
36623662 // An opaque string that indicates the position at which to begin describing
36633663 // the VTL devices.
3664 Marker *string `type:"string"`
3664 Marker *string `min:"1" type:"string"`
36653665
36663666 // An array of strings, where each string represents the Amazon Resource Name
36673667 // (ARN) of a VTL device.
36923692 type DescribeVTLDevicesOutput struct {
36933693 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
36943694 // to return a list of gateways for your account and region.
3695 GatewayARN *string `type:"string"`
3695 GatewayARN *string `min:"50" type:"string"`
36963696
36973697 // An opaque string that indicates the position at which the VTL devices that
36983698 // were fetched for description ended. Use the marker in your next request to
36993699 // fetch the next set of VTL devices in the list. If there are no more VTL devices
37003700 // to describe, this field does not appear in the response.
3701 Marker *string `type:"string"`
3701 Marker *string `min:"1" type:"string"`
37023702
37033703 // An array of VTL device objects composed of the Amazon Resource Name(ARN)
37043704 // of the VTL devices.
37253725 type DescribeWorkingStorageInput struct {
37263726 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
37273727 // to return a list of gateways for your account and region.
3728 GatewayARN *string `type:"string" required:"true"`
3728 GatewayARN *string `min:"50" type:"string" required:"true"`
37293729
37303730 metadataDescribeWorkingStorageInput `json:"-" xml:"-"`
37313731 }
37543754
37553755 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
37563756 // to return a list of gateways for your account and region.
3757 GatewayARN *string `type:"string"`
3757 GatewayARN *string `min:"50" type:"string"`
37583758
37593759 // The total working storage in bytes allocated for the gateway. If no working
37603760 // storage is configured for the gateway, this field returns 0.
37943794
37953795 // Specifies the unique Amazon Resource Name(ARN) that encodes the iSCSI qualified
37963796 // name(iqn) of a tape drive or media changer target.
3797 TargetARN *string `type:"string"`
3797 TargetARN *string `min:"50" type:"string"`
37983798
37993799 metadataDeviceiSCSIAttributes `json:"-" xml:"-"`
38003800 }
38173817 type DisableGatewayInput struct {
38183818 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
38193819 // to return a list of gateways for your account and region.
3820 GatewayARN *string `type:"string" required:"true"`
3820 GatewayARN *string `min:"50" type:"string" required:"true"`
38213821
38223822 metadataDisableGatewayInput `json:"-" xml:"-"`
38233823 }
38393839 // DisableGatewayOutput
38403840 type DisableGatewayOutput struct {
38413841 // The unique Amazon Resource Name of the disabled gateway.
3842 GatewayARN *string `type:"string"`
3842 GatewayARN *string `min:"50" type:"string"`
38433843
38443844 metadataDisableGatewayOutput `json:"-" xml:"-"`
38453845 }
38613861 type Disk struct {
38623862 DiskAllocationResource *string `type:"string"`
38633863
3864 DiskAllocationType *string `type:"string"`
3865
3866 DiskId *string `type:"string"`
3864 DiskAllocationType *string `min:"3" type:"string"`
3865
3866 DiskId *string `min:"1" type:"string"`
38673867
38683868 DiskNode *string `type:"string"`
38693869
39203920 type GatewayInfo struct {
39213921 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
39223922 // to return a list of gateways for your account and region.
3923 GatewayARN *string `type:"string"`
3923 GatewayARN *string `min:"50" type:"string"`
39243924
39253925 GatewayName *string `type:"string"`
39263926
3927 GatewayOperationalState *string `type:"string"`
3928
3929 GatewayType *string `type:"string"`
3927 GatewayOperationalState *string `min:"2" type:"string"`
3928
3929 GatewayType *string `min:"2" type:"string"`
39303930
39313931 metadataGatewayInfo `json:"-" xml:"-"`
39323932 }
39513951 type ListGatewaysInput struct {
39523952 // Specifies that the list of gateways returned be limited to the specified
39533953 // number of items.
3954 Limit *int64 `type:"integer"`
3954 Limit *int64 `min:"1" type:"integer"`
39553955
39563956 // An opaque string that indicates the position at which to begin the returned
39573957 // list of gateways.
3958 Marker *string `type:"string"`
3958 Marker *string `min:"1" type:"string"`
39593959
39603960 metadataListGatewaysInput `json:"-" xml:"-"`
39613961 }
39773977 type ListGatewaysOutput struct {
39783978 Gateways []*GatewayInfo `type:"list"`
39793979
3980 Marker *string `type:"string"`
3980 Marker *string `min:"1" type:"string"`
39813981
39823982 metadataListGatewaysOutput `json:"-" xml:"-"`
39833983 }
40004000 type ListLocalDisksInput struct {
40014001 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
40024002 // to return a list of gateways for your account and region.
4003 GatewayARN *string `type:"string" required:"true"`
4003 GatewayARN *string `min:"50" type:"string" required:"true"`
40044004
40054005 metadataListLocalDisksInput `json:"-" xml:"-"`
40064006 }
40244024
40254025 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
40264026 // to return a list of gateways for your account and region.
4027 GatewayARN *string `type:"string"`
4027 GatewayARN *string `min:"50" type:"string"`
40284028
40294029 metadataListLocalDisksOutput `json:"-" xml:"-"`
40304030 }
40474047 type ListTagsForResourceInput struct {
40484048 // Specifies that the list of tags returned be limited to the specified number
40494049 // of items.
4050 Limit *int64 `type:"integer"`
4050 Limit *int64 `min:"1" type:"integer"`
40514051
40524052 // An opaque string that indicates the position at which to begin returning
40534053 // the list of tags.
4054 Marker *string `type:"string"`
4054 Marker *string `min:"1" type:"string"`
40554055
40564056 // The Amazon Resource Name (ARN) of the resource for which you want to list
40574057 // tags.
4058 ResourceARN *string `type:"string"`
4058 ResourceARN *string `min:"50" type:"string"`
40594059
40604060 metadataListTagsForResourceInput `json:"-" xml:"-"`
40614061 }
40784078 type ListTagsForResourceOutput struct {
40794079 // An opaque string that indicates the position at which to stop returning the
40804080 // list of tags.
4081 Marker *string `type:"string"`
4081 Marker *string `min:"1" type:"string"`
40824082
40834083 // he Amazon Resource Name (ARN) of the resource for which you want to list
40844084 // tags.
4085 ResourceARN *string `type:"string"`
4085 ResourceARN *string `min:"50" type:"string"`
40864086
40874087 // An array that contains the tags for the specified resource.
40884088 Tags []*Tag `type:"list"`
41084108 type ListVolumeInitiatorsInput struct {
41094109 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
41104110 // to return a list of gateway volumes for the gateway.
4111 VolumeARN *string `type:"string" required:"true"`
4111 VolumeARN *string `min:"50" type:"string" required:"true"`
41124112
41134113 metadataListVolumeInitiatorsInput `json:"-" xml:"-"`
41144114 }
41534153 type ListVolumeRecoveryPointsInput struct {
41544154 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
41554155 // to return a list of gateways for your account and region.
4156 GatewayARN *string `type:"string" required:"true"`
4156 GatewayARN *string `min:"50" type:"string" required:"true"`
41574157
41584158 metadataListVolumeRecoveryPointsInput `json:"-" xml:"-"`
41594159 }
41754175 type ListVolumeRecoveryPointsOutput struct {
41764176 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
41774177 // to return a list of gateways for your account and region.
4178 GatewayARN *string `type:"string"`
4178 GatewayARN *string `min:"50" type:"string"`
41794179
41804180 VolumeRecoveryPointInfos []*VolumeRecoveryPointInfo `type:"list"`
41814181
42024202 type ListVolumesInput struct {
42034203 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
42044204 // to return a list of gateways for your account and region.
4205 GatewayARN *string `type:"string" required:"true"`
4205 GatewayARN *string `min:"50" type:"string" required:"true"`
42064206
42074207 // Specifies that the list of volumes returned be limited to the specified number
42084208 // of items.
4209 Limit *int64 `type:"integer"`
4209 Limit *int64 `min:"1" type:"integer"`
42104210
42114211 // A string that indicates the position at which to begin the returned list
42124212 // of volumes. Obtain the marker from the response of a previous List iSCSI
42134213 // Volumes request.
4214 Marker *string `type:"string"`
4214 Marker *string `min:"1" type:"string"`
42154215
42164216 metadataListVolumesInput `json:"-" xml:"-"`
42174217 }
42334233 type ListVolumesOutput struct {
42344234 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
42354235 // to return a list of gateways for your account and region.
4236 GatewayARN *string `type:"string"`
4237
4238 Marker *string `type:"string"`
4236 GatewayARN *string `min:"50" type:"string"`
4237
4238 Marker *string `min:"1" type:"string"`
42394239
42404240 VolumeInfos []*VolumeInfo `type:"list"`
42414241
42914291 type RemoveTagsFromResourceInput struct {
42924292 // The Amazon Resource Name (ARN) of the resource you want to remove the tags
42934293 // from.
4294 ResourceARN *string `type:"string"`
4294 ResourceARN *string `min:"50" type:"string"`
42954295
42964296 // The keys of the tags you want to remove from the specified resource. A tag
42974297 // is composed of a key/value pair.
43184318 type RemoveTagsFromResourceOutput struct {
43194319 // The Amazon Resource Name (ARN) of the resource that the tags were removed
43204320 // from.
4321 ResourceARN *string `type:"string"`
4321 ResourceARN *string `min:"50" type:"string"`
43224322
43234323 metadataRemoveTagsFromResourceOutput `json:"-" xml:"-"`
43244324 }
43404340 type ResetCacheInput struct {
43414341 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
43424342 // to return a list of gateways for your account and region.
4343 GatewayARN *string `type:"string" required:"true"`
4343 GatewayARN *string `min:"50" type:"string" required:"true"`
43444344
43454345 metadataResetCacheInput `json:"-" xml:"-"`
43464346 }
43624362 type ResetCacheOutput struct {
43634363 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
43644364 // to return a list of gateways for your account and region.
4365 GatewayARN *string `type:"string"`
4365 GatewayARN *string `min:"50" type:"string"`
43664366
43674367 metadataResetCacheOutput `json:"-" xml:"-"`
43684368 }
43894389 //
43904390 // You retrieve archived virtual tapes to only one gateway and the gateway
43914391 // must be a gateway-VTL.
4392 GatewayARN *string `type:"string" required:"true"`
4392 GatewayARN *string `min:"50" type:"string" required:"true"`
43934393
43944394 // The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from
43954395 // the virtual tape shelf (VTS).
4396 TapeARN *string `type:"string" required:"true"`
4396 TapeARN *string `min:"50" type:"string" required:"true"`
43974397
43984398 metadataRetrieveTapeArchiveInput `json:"-" xml:"-"`
43994399 }
44154415 // RetrieveTapeArchiveOutput
44164416 type RetrieveTapeArchiveOutput struct {
44174417 // The Amazon Resource Name (ARN) of the retrieved virtual tape.
4418 TapeARN *string `type:"string"`
4418 TapeARN *string `min:"50" type:"string"`
44194419
44204420 metadataRetrieveTapeArchiveOutput `json:"-" xml:"-"`
44214421 }
44384438 type RetrieveTapeRecoveryPointInput struct {
44394439 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
44404440 // to return a list of gateways for your account and region.
4441 GatewayARN *string `type:"string" required:"true"`
4441 GatewayARN *string `min:"50" type:"string" required:"true"`
44424442
44434443 // The Amazon Resource Name (ARN) of the virtual tape for which you want to
44444444 // retrieve the recovery point.
4445 TapeARN *string `type:"string" required:"true"`
4445 TapeARN *string `min:"50" type:"string" required:"true"`
44464446
44474447 metadataRetrieveTapeRecoveryPointInput `json:"-" xml:"-"`
44484448 }
44654465 type RetrieveTapeRecoveryPointOutput struct {
44664466 // The Amazon Resource Name (ARN) of the virtual tape for which the recovery
44674467 // point was retrieved.
4468 TapeARN *string `type:"string"`
4468 TapeARN *string `min:"50" type:"string"`
44694469
44704470 metadataRetrieveTapeRecoveryPointOutput `json:"-" xml:"-"`
44714471 }
44884488 type ShutdownGatewayInput struct {
44894489 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
44904490 // to return a list of gateways for your account and region.
4491 GatewayARN *string `type:"string" required:"true"`
4491 GatewayARN *string `min:"50" type:"string" required:"true"`
44924492
44934493 metadataShutdownGatewayInput `json:"-" xml:"-"`
44944494 }
45114511 type ShutdownGatewayOutput struct {
45124512 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
45134513 // to return a list of gateways for your account and region.
4514 GatewayARN *string `type:"string"`
4514 GatewayARN *string `min:"50" type:"string"`
45154515
45164516 metadataShutdownGatewayOutput `json:"-" xml:"-"`
45174517 }
45344534 type StartGatewayInput struct {
45354535 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
45364536 // to return a list of gateways for your account and region.
4537 GatewayARN *string `type:"string" required:"true"`
4537 GatewayARN *string `min:"50" type:"string" required:"true"`
45384538
45394539 metadataStartGatewayInput `json:"-" xml:"-"`
45404540 }
45574557 type StartGatewayOutput struct {
45584558 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
45594559 // to return a list of gateways for your account and region.
4560 GatewayARN *string `type:"string"`
4560 GatewayARN *string `min:"50" type:"string"`
45614561
45624562 metadataStartGatewayOutput `json:"-" xml:"-"`
45634563 }
45814581
45824582 SourceSnapshotId *string `type:"string"`
45834583
4584 VolumeARN *string `type:"string"`
4585
4586 VolumeDiskId *string `type:"string"`
4587
4588 VolumeId *string `type:"string"`
4584 VolumeARN *string `min:"50" type:"string"`
4585
4586 VolumeDiskId *string `min:"1" type:"string"`
4587
4588 VolumeId *string `min:"12" type:"string"`
45894589
45904590 VolumeProgress *float64 `type:"double"`
45914591
45924592 VolumeSizeInBytes *int64 `type:"long"`
45934593
4594 VolumeStatus *string `type:"string"`
4595
4596 VolumeType *string `type:"string"`
4594 VolumeStatus *string `min:"3" type:"string"`
4595
4596 VolumeType *string `min:"3" type:"string"`
45974597
45984598 // Lists iSCSI information about a volume.
45994599 VolumeiSCSIAttributes *VolumeiSCSIAttributes `type:"structure"`
46164616 }
46174617
46184618 type Tag struct {
4619 Key *string `type:"string" required:"true"`
4619 Key *string `min:"1" type:"string" required:"true"`
46204620
46214621 Value *string `type:"string" required:"true"`
46224622
46464646 Progress *float64 `type:"double"`
46474647
46484648 // The Amazon Resource Name (ARN) of the virtual tape.
4649 TapeARN *string `type:"string"`
4649 TapeARN *string `min:"50" type:"string"`
46504650
46514651 // The barcode that identifies a specific virtual tape.
4652 TapeBarcode *string `type:"string"`
4652 TapeBarcode *string `min:"7" type:"string"`
46534653
46544654 // The size, in bytes, of the virtual tape.
46554655 TapeSizeInBytes *int64 `type:"long"`
46594659
46604660 // The virtual tape library (VTL) device that the virtual tape is associated
46614661 // with.
4662 VTLDevice *string `type:"string"`
4662 VTLDevice *string `min:"50" type:"string"`
46634663
46644664 metadataTape `json:"-" xml:"-"`
46654665 }
46904690 // being retrieved to.
46914691 //
46924692 // The virtual tape is retrieved from the virtual tape shelf (VTS).
4693 RetrievedTo *string `type:"string"`
4693 RetrievedTo *string `min:"50" type:"string"`
46944694
46954695 // The Amazon Resource Name (ARN) of an archived virtual tape.
4696 TapeARN *string `type:"string"`
4696 TapeARN *string `min:"50" type:"string"`
46974697
46984698 // The barcode that identifies the archived virtual tape.
4699 TapeBarcode *string `type:"string"`
4699 TapeBarcode *string `min:"7" type:"string"`
47004700
47014701 // The size, in bytes, of the archived virtual tape.
47024702 TapeSizeInBytes *int64 `type:"long"`
47244724 // Describes a recovery point.
47254725 type TapeRecoveryPointInfo struct {
47264726 // The Amazon Resource Name (ARN) of the virtual tape.
4727 TapeARN *string `type:"string"`
4727 TapeARN *string `min:"50" type:"string"`
47284728
47294729 // The time when the point-in-time view of the virtual tape was replicated for
47304730 // later recovery.
47604760 // UpdateBandwidthRateLimitInput$AverageDownloadRateLimitInBitsPerSec UpdateBandwidthRateLimitInput$AverageUploadRateLimitInBitsPerSec
47614761 type UpdateBandwidthRateLimitInput struct {
47624762 // The average download bandwidth rate limit in bits per second.
4763 AverageDownloadRateLimitInBitsPerSec *int64 `type:"long"`
4763 AverageDownloadRateLimitInBitsPerSec *int64 `min:"102400" type:"long"`
47644764
47654765 // The average upload bandwidth rate limit in bits per second.
4766 AverageUploadRateLimitInBitsPerSec *int64 `type:"long"`
4767
4768 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
4769 // to return a list of gateways for your account and region.
4770 GatewayARN *string `type:"string" required:"true"`
4766 AverageUploadRateLimitInBitsPerSec *int64 `min:"51200" type:"long"`
4767
4768 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
4769 // to return a list of gateways for your account and region.
4770 GatewayARN *string `min:"50" type:"string" required:"true"`
47714771
47724772 metadataUpdateBandwidthRateLimitInput `json:"-" xml:"-"`
47734773 }
47914791 type UpdateBandwidthRateLimitOutput struct {
47924792 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
47934793 // to return a list of gateways for your account and region.
4794 GatewayARN *string `type:"string"`
4794 GatewayARN *string `min:"50" type:"string"`
47954795
47964796 metadataUpdateBandwidthRateLimitOutput `json:"-" xml:"-"`
47974797 }
48164816 // UpdateChapCredentialsInput$SecretToAuthenticateTarget UpdateChapCredentialsInput$TargetARN
48174817 type UpdateChapCredentialsInput struct {
48184818 // The iSCSI initiator that connects to the target.
4819 InitiatorName *string `type:"string" required:"true"`
4819 InitiatorName *string `min:"1" type:"string" required:"true"`
48204820
48214821 // The secret key that the initiator (for example, the Windows client) must
48224822 // provide to participate in mutual CHAP with the target.
48234823 //
48244824 // The secret key must be between 12 and 16 bytes when encoded in UTF-8.
4825 SecretToAuthenticateInitiator *string `type:"string" required:"true"`
4825 SecretToAuthenticateInitiator *string `min:"1" type:"string" required:"true"`
48264826
48274827 // The secret key that the target must provide to participate in mutual CHAP
48284828 // with the initiator (e.g. Windows client).
48304830 // Byte constraints: Minimum bytes of 12. Maximum bytes of 16.
48314831 //
48324832 // The secret key must be between 12 and 16 bytes when encoded in UTF-8.
4833 SecretToAuthenticateTarget *string `type:"string"`
4833 SecretToAuthenticateTarget *string `min:"1" type:"string"`
48344834
48354835 // The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes
48364836 // operation to return the TargetARN for specified VolumeARN.
4837 TargetARN *string `type:"string" required:"true"`
4837 TargetARN *string `min:"50" type:"string" required:"true"`
48384838
48394839 metadataUpdateChapCredentialsInput `json:"-" xml:"-"`
48404840 }
48574857 type UpdateChapCredentialsOutput struct {
48584858 // The iSCSI initiator that connects to the target. This is the same initiator
48594859 // name specified in the request.
4860 InitiatorName *string `type:"string"`
4860 InitiatorName *string `min:"1" type:"string"`
48614861
48624862 // The Amazon Resource Name (ARN) of the target. This is the same target specified
48634863 // in the request.
4864 TargetARN *string `type:"string"`
4864 TargetARN *string `min:"50" type:"string"`
48654865
48664866 metadataUpdateChapCredentialsOutput `json:"-" xml:"-"`
48674867 }
48834883 type UpdateGatewayInformationInput struct {
48844884 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
48854885 // to return a list of gateways for your account and region.
4886 GatewayARN *string `type:"string" required:"true"`
4886 GatewayARN *string `min:"50" type:"string" required:"true"`
48874887
48884888 // A unique identifier for your gateway. This name becomes part of the gateway
48894889 // Amazon Resources Name (ARN) which is what you use as an input to other operations.
4890 GatewayName *string `type:"string"`
4891
4892 GatewayTimezone *string `type:"string"`
4890 GatewayName *string `min:"2" type:"string"`
4891
4892 GatewayTimezone *string `min:"3" type:"string"`
48934893
48944894 metadataUpdateGatewayInformationInput `json:"-" xml:"-"`
48954895 }
49124912 type UpdateGatewayInformationOutput struct {
49134913 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
49144914 // to return a list of gateways for your account and region.
4915 GatewayARN *string `type:"string"`
4915 GatewayARN *string `min:"50" type:"string"`
49164916
49174917 GatewayName *string `type:"string"`
49184918
49374937 type UpdateGatewaySoftwareNowInput struct {
49384938 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
49394939 // to return a list of gateways for your account and region.
4940 GatewayARN *string `type:"string" required:"true"`
4940 GatewayARN *string `min:"50" type:"string" required:"true"`
49414941
49424942 metadataUpdateGatewaySoftwareNowInput `json:"-" xml:"-"`
49434943 }
49604960 type UpdateGatewaySoftwareNowOutput struct {
49614961 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
49624962 // to return a list of gateways for your account and region.
4963 GatewayARN *string `type:"string"`
4963 GatewayARN *string `min:"50" type:"string"`
49644964
49654965 metadataUpdateGatewaySoftwareNowOutput `json:"-" xml:"-"`
49664966 }
49894989
49904990 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
49914991 // to return a list of gateways for your account and region.
4992 GatewayARN *string `type:"string" required:"true"`
4992 GatewayARN *string `min:"50" type:"string" required:"true"`
49934993
49944994 // The hour component of the maintenance start time represented as hh, where
49954995 // hh is the hour (00 to 23). The hour of the day is in the time zone of the
50235023 type UpdateMaintenanceStartTimeOutput struct {
50245024 // The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
50255025 // to return a list of gateways for your account and region.
5026 GatewayARN *string `type:"string"`
5026 GatewayARN *string `min:"50" type:"string"`
50275027
50285028 metadataUpdateMaintenanceStartTimeOutput `json:"-" xml:"-"`
50295029 }
50485048 // UpdateSnapshotScheduleInput$StartAt UpdateSnapshotScheduleInput$VolumeARN
50495049 type UpdateSnapshotScheduleInput struct {
50505050 // Optional description of the snapshot that overwrites the existing description.
5051 Description *string `type:"string"`
5051 Description *string `min:"1" type:"string"`
50525052
50535053 // Frequency of snapshots. Specify the number of hours between snapshots.
5054 RecurrenceInHours *int64 `type:"integer" required:"true"`
5054 RecurrenceInHours *int64 `min:"1" type:"integer" required:"true"`
50555055
50565056 // The hour of the day at which the snapshot schedule begins represented as
50575057 // hh, where hh is the hour (0 to 23). The hour of the day is in the time zone
50605060
50615061 // The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation
50625062 // to return a list of gateway volumes.
5063 VolumeARN *string `type:"string" required:"true"`
5063 VolumeARN *string `min:"50" type:"string" required:"true"`
50645064
50655065 metadataUpdateSnapshotScheduleInput `json:"-" xml:"-"`
50665066 }
50815081
50825082 // A JSON object containing the of the updated storage volume.
50835083 type UpdateSnapshotScheduleOutput struct {
5084 VolumeARN *string `type:"string"`
5084 VolumeARN *string `min:"50" type:"string"`
50855085
50865086 metadataUpdateSnapshotScheduleOutput `json:"-" xml:"-"`
50875087 }
51055105 // The type of medium changer you want to select.
51065106 //
51075107 // Valid Values: "STK-L700", "AWS-Gateway-VTL"
5108 DeviceType *string `type:"string" required:"true"`
5108 DeviceType *string `min:"2" type:"string" required:"true"`
51095109
51105110 // The Amazon Resource Name (ARN) of the medium changer you want to select.
5111 VTLDeviceARN *string `type:"string" required:"true"`
5111 VTLDeviceARN *string `min:"50" type:"string" required:"true"`
51125112
51135113 metadataUpdateVTLDeviceTypeInput `json:"-" xml:"-"`
51145114 }
51305130 // UpdateVTLDeviceTypeOutput
51315131 type UpdateVTLDeviceTypeOutput struct {
51325132 // The Amazon Resource Name (ARN) of the medium changer you have selected.
5133 VTLDeviceARN *string `type:"string"`
5133 VTLDeviceARN *string `min:"50" type:"string"`
51345134
51355135 metadataUpdateVTLDeviceTypeOutput `json:"-" xml:"-"`
51365136 }
51565156
51575157 // Specifies the unique Amazon Resource Name (ARN) of the device (tape drive
51585158 // or media changer).
5159 VTLDeviceARN *string `type:"string"`
5159 VTLDeviceARN *string `min:"50" type:"string"`
51605160
51615161 VTLDeviceProductIdentifier *string `type:"string"`
51625162
51825182 }
51835183
51845184 type VolumeInfo struct {
5185 VolumeARN *string `type:"string"`
5186
5187 VolumeType *string `type:"string"`
5185 VolumeARN *string `min:"50" type:"string"`
5186
5187 VolumeType *string `min:"3" type:"string"`
51885188
51895189 metadataVolumeInfo `json:"-" xml:"-"`
51905190 }
52045204 }
52055205
52065206 type VolumeRecoveryPointInfo struct {
5207 VolumeARN *string `type:"string"`
5207 VolumeARN *string `min:"50" type:"string"`
52085208
52095209 VolumeRecoveryPointTime *string `type:"string"`
52105210
52355235 ChapEnabled *bool `type:"boolean"`
52365236
52375237 // The logical disk number.
5238 LunNumber *int64 `type:"integer"`
5238 LunNumber *int64 `min:"1" type:"integer"`
52395239
52405240 // The network interface identifier.
52415241 NetworkInterfaceId *string `type:"string"`
52445244 NetworkInterfacePort *int64 `type:"integer"`
52455245
52465246 // The Amazon Resource Name (ARN) of the volume target.
5247 TargetARN *string `type:"string"`
5247 TargetARN *string `min:"50" type:"string"`
52485248
52495249 metadataVolumeiSCSIAttributes `json:"-" xml:"-"`
52505250 }
+31
-31
service/sts/api.go less more
470470 // The duration, in seconds, of the role session. The value can range from 900
471471 // seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set
472472 // to 3600 seconds.
473 DurationSeconds *int64 `type:"integer"`
473 DurationSeconds *int64 `min:"900" type:"integer"`
474474
475475 // A unique identifier that is used by third parties when assuming roles in
476476 // their customers' accounts. For each role that the third party can assume,
481481 // created it. For more information about the external ID, see How to Use External
482482 // ID When Granting Access to Your AWS Resources (http://docs.aws.amazon.com/STS/latest/UsingSTS/sts-delegating-externalid.html)
483483 // in Using Temporary Security Credentials.
484 ExternalId *string `type:"string"`
484 ExternalId *string `min:"2" type:"string"`
485485
486486 // An IAM policy in JSON format.
487487 //
501501 // The PackedPolicySize response element indicates by percentage how close to
502502 // the upper size limit the policy is, with 100% equaling the maximum allowed
503503 // size.
504 Policy *string `type:"string"`
504 Policy *string `min:"1" type:"string"`
505505
506506 // The Amazon Resource Name (ARN) of the role to assume.
507 RoleArn *string `type:"string" required:"true"`
507 RoleArn *string `min:"20" type:"string" required:"true"`
508508
509509 // An identifier for the assumed role session.
510510 //
515515 // of the assumed role principal. This means that subsequent cross-account API
516516 // requests using the temporary security credentials will expose the role session
517517 // name to the external account in their CloudTrail logs.
518 RoleSessionName *string `type:"string" required:"true"`
518 RoleSessionName *string `min:"2" type:"string" required:"true"`
519519
520520 // The identification number of the MFA device that is associated with the user
521521 // who is making the AssumeRole call. Specify this value if the trust policy
522522 // of the role being assumed includes a condition that requires MFA authentication.
523523 // The value is either the serial number for a hardware device (such as GAHT12345678)
524524 // or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
525 SerialNumber *string `type:"string"`
525 SerialNumber *string `min:"9" type:"string"`
526526
527527 // The value provided by the MFA device, if the trust policy of the role being
528528 // assumed requires MFA (that is, if the policy includes a condition that tests
529529 // for MFA). If the role being assumed requires MFA and if the TokenCode value
530530 // is missing or expired, the AssumeRole call returns an "access denied" error.
531 TokenCode *string `type:"string"`
531 TokenCode *string `min:"6" type:"string"`
532532
533533 metadataAssumeRoleInput `json:"-" xml:"-"`
534534 }
592592 //
593593 // The maximum duration for a session is 1 hour, and the minimum duration is
594594 // 15 minutes, even if values outside this range are specified.
595 DurationSeconds *int64 `type:"integer"`
595 DurationSeconds *int64 `min:"900" type:"integer"`
596596
597597 // An IAM policy in JSON format.
598598 //
611611 // The PackedPolicySize response element indicates by percentage how close to
612612 // the upper size limit the policy is, with 100% equaling the maximum allowed
613613 // size.
614 Policy *string `type:"string"`
614 Policy *string `min:"1" type:"string"`
615615
616616 // The Amazon Resource Name (ARN) of the SAML provider in IAM that describes
617617 // the IdP.
618 PrincipalArn *string `type:"string" required:"true"`
618 PrincipalArn *string `min:"20" type:"string" required:"true"`
619619
620620 // The Amazon Resource Name (ARN) of the role that the caller is assuming.
621 RoleArn *string `type:"string" required:"true"`
621 RoleArn *string `min:"20" type:"string" required:"true"`
622622
623623 // The base-64 encoded SAML authentication response provided by the IdP.
624624 //
625625 // For more information, see Configuring a Relying Party and Adding Claims
626626 // (http://docs.aws.amazon.com/IAM/latest/UserGuide/create-role-saml-IdP-tasks.html)
627627 // in the Using IAM guide.
628 SAMLAssertion *string `type:"string" required:"true"`
628 SAMLAssertion *string `min:"4" type:"string" required:"true"`
629629
630630 metadataAssumeRoleWithSAMLInput `json:"-" xml:"-"`
631631 }
711711 // The duration, in seconds, of the role session. The value can range from 900
712712 // seconds (15 minutes) to 3600 seconds (1 hour). By default, the value is set
713713 // to 3600 seconds.
714 DurationSeconds *int64 `type:"integer"`
714 DurationSeconds *int64 `min:"900" type:"integer"`
715715
716716 // An IAM policy in JSON format.
717717 //
729729 // The PackedPolicySize response element indicates by percentage how close to
730730 // the upper size limit the policy is, with 100% equaling the maximum allowed
731731 // size.
732 Policy *string `type:"string"`
732 Policy *string `min:"1" type:"string"`
733733
734734 // The fully qualified host component of the domain name of the identity provider.
735735 //
738738 // 2.0 access tokens. Do not include URL schemes and port numbers.
739739 //
740740 // Do not specify this value for OpenID Connect ID tokens.
741 ProviderId *string `type:"string"`
741 ProviderId *string `min:"4" type:"string"`
742742
743743 // The Amazon Resource Name (ARN) of the role that the caller is assuming.
744 RoleArn *string `type:"string" required:"true"`
744 RoleArn *string `min:"20" type:"string" required:"true"`
745745
746746 // An identifier for the assumed role session. Typically, you pass the name
747747 // or identifier that is associated with the user who is using your application.
748748 // That way, the temporary security credentials that your application will use
749749 // are associated with that user. This session name is included as part of the
750750 // ARN and assumed role ID in the AssumedRoleUser response element.
751 RoleSessionName *string `type:"string" required:"true"`
751 RoleSessionName *string `min:"2" type:"string" required:"true"`
752752
753753 // The OAuth 2.0 access token or OpenID Connect ID token that is provided by
754754 // the identity provider. Your application must get this token by authenticating
755755 // the user who is using your application with a web identity provider before
756756 // the application makes an AssumeRoleWithWebIdentity call.
757 WebIdentityToken *string `type:"string" required:"true"`
757 WebIdentityToken *string `min:"4" type:"string" required:"true"`
758758
759759 metadataAssumeRoleWithWebIdentityInput `json:"-" xml:"-"`
760760 }
809809 // the user and the application that acquired the WebIdentityToken (pairwise
810810 // identifier). For OpenID Connect ID tokens, this field contains the value
811811 // returned by the identity provider as the token's sub (Subject) claim.
812 SubjectFromWebIdentityToken *string `type:"string"`
812 SubjectFromWebIdentityToken *string `min:"6" type:"string"`
813813
814814 metadataAssumeRoleWithWebIdentityOutput `json:"-" xml:"-"`
815815 }
835835 // AssumeRole action. For more information about ARNs and how to use them in
836836 // policies, see IAM Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
837837 // in Using IAM.
838 Arn *string `type:"string" required:"true"`
838 Arn *string `min:"20" type:"string" required:"true"`
839839
840840 // A unique identifier that contains the role ID and the role session name of
841841 // the role that is being assumed. The role ID is generated by AWS when the
842842 // role is created.
843 AssumedRoleId *string `type:"string" required:"true"`
843 AssumedRoleId *string `min:"2" type:"string" required:"true"`
844844
845845 metadataAssumedRoleUser `json:"-" xml:"-"`
846846 }
862862 // AWS credentials for API authentication.
863863 type Credentials struct {
864864 // The access key ID that identifies the temporary security credentials.
865 AccessKeyId *string `type:"string" required:"true"`
865 AccessKeyId *string `min:"16" type:"string" required:"true"`
866866
867867 // The date on which the current credentials expire.
868868 Expiration *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
892892
893893 type DecodeAuthorizationMessageInput struct {
894894 // The encoded message that was returned with the response.
895 EncodedMessage *string `type:"string" required:"true"`
895 EncodedMessage *string `min:"1" type:"string" required:"true"`
896896
897897 metadataDecodeAuthorizationMessageInput `json:"-" xml:"-"`
898898 }
942942 // For more information about ARNs and how to use them in policies, see IAM
943943 // Identifiers (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html)
944944 // in Using IAM.
945 Arn *string `type:"string" required:"true"`
945 Arn *string `min:"20" type:"string" required:"true"`
946946
947947 // The string that identifies the federated user associated with the credentials,
948948 // similar to the unique ID of an IAM user.
949 FederatedUserId *string `type:"string" required:"true"`
949 FederatedUserId *string `min:"2" type:"string" required:"true"`
950950
951951 metadataFederatedUser `json:"-" xml:"-"`
952952 }
973973 // seconds (one hour). If the specified duration is longer than one hour, the
974974 // session obtained by using AWS account (root) credentials defaults to one
975975 // hour.
976 DurationSeconds *int64 `type:"integer"`
976 DurationSeconds *int64 `min:"900" type:"integer"`
977977
978978 // The name of the federated user. The name is used as an identifier for the
979979 // temporary security credentials (such as Bob). For example, you can reference
980980 // the federated user name in a resource-based policy, such as in an Amazon
981981 // S3 bucket policy.
982 Name *string `type:"string" required:"true"`
982 Name *string `min:"2" type:"string" required:"true"`
983983
984984 // An IAM policy in JSON format that is passed with the GetFederationToken call
985985 // and evaluated along with the policy or policies that are attached to the
10021002 // the upper size limit the policy is, with 100% equaling the maximum allowed
10031003 // size. For more information about how permissions work, see Permissions for
10041004 // GetFederationToken (http://docs.aws.amazon.com/STS/latest/UsingSTS/permissions-get-federation-token.html).
1005 Policy *string `type:"string"`
1005 Policy *string `min:"1" type:"string"`
10061006
10071007 metadataGetFederationTokenInput `json:"-" xml:"-"`
10081008 }
10621062 // for AWS account owners are restricted to a maximum of 3600 seconds (one hour).
10631063 // If the duration is longer than one hour, the session for AWS account owners
10641064 // defaults to one hour.
1065 DurationSeconds *int64 `type:"integer"`
1065 DurationSeconds *int64 `min:"900" type:"integer"`
10661066
10671067 // The identification number of the MFA device that is associated with the IAM
10681068 // user who is making the GetSessionToken call. Specify this value if the IAM
10711071 // Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).
10721072 // You can find the device for an IAM user by going to the AWS Management Console
10731073 // and viewing the user's security credentials.
1074 SerialNumber *string `type:"string"`
1074 SerialNumber *string `min:"9" type:"string"`
10751075
10761076 // The value provided by the MFA device, if MFA is required. If any policy requires
10771077 // the IAM user to submit an MFA code, specify this value. If MFA authentication
10781078 // is required, and the user does not provide a code when requesting a set of
10791079 // temporary security credentials, the user will receive an "access denied"
10801080 // response when requesting resources that require MFA authentication.
1081 TokenCode *string `type:"string"`
1081 TokenCode *string `min:"6" type:"string"`
10821082
10831083 metadataGetSessionTokenInput `json:"-" xml:"-"`
10841084 }
+3
-3
service/sts/customizations_test.go less more
1313
1414 func TestUnsignedRequest_AssumeRoleWithSAML(t *testing.T) {
1515 req, _ := svc.AssumeRoleWithSAMLRequest(&sts.AssumeRoleWithSAMLInput{
16 PrincipalArn: aws.String("ARN"),
17 RoleArn: aws.String("ARN"),
16 PrincipalArn: aws.String("ARN01234567890123456789"),
17 RoleArn: aws.String("ARN01234567890123456789"),
1818 SAMLAssertion: aws.String("ASSERT"),
1919 })
2020
2525
2626 func TestUnsignedRequest_AssumeRoleWithWebIdentity(t *testing.T) {
2727 req, _ := svc.AssumeRoleWithWebIdentityRequest(&sts.AssumeRoleWithWebIdentityInput{
28 RoleArn: aws.String("ARN"),
28 RoleArn: aws.String("ARN01234567890123456789"),
2929 RoleSessionName: aws.String("SESSION"),
3030 WebIdentityToken: aws.String("TOKEN"),
3131 })
+2
-2
service/support/api.go less more
984984 Language *string `locationName:"language" type:"string"`
985985
986986 // The maximum number of results to return before paginating.
987 MaxResults *int64 `locationName:"maxResults" type:"integer"`
987 MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`
988988
989989 // A resumption point for pagination.
990990 NextToken *string `locationName:"nextToken" type:"string"`
10461046 CaseId *string `locationName:"caseId" type:"string" required:"true"`
10471047
10481048 // The maximum number of results to return before paginating.
1049 MaxResults *int64 `locationName:"maxResults" type:"integer"`
1049 MaxResults *int64 `locationName:"maxResults" min:"10" type:"integer"`
10501050
10511051 // A resumption point for pagination.
10521052 NextToken *string `locationName:"nextToken" type:"string"`
+109
-109
service/swf/api.go less more
15771577 // Provides details of the ActivityTaskCancelRequested event.
15781578 type ActivityTaskCancelRequestedEventAttributes struct {
15791579 // The unique ID of the task.
1580 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
1580 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
15811581
15821582 // The ID of the DecisionTaskCompleted event corresponding to the decision task
15831583 // that resulted in the RequestCancelActivityTask decision for this cancellation
17091709 // Provides details of the ActivityTaskScheduled event.
17101710 type ActivityTaskScheduledEventAttributes struct {
17111711 // The unique ID of the activity task.
1712 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
1712 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
17131713
17141714 // The type of the activity task.
17151715 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
18451845 //
18461846 // The combination of activity type name and version must be unique within
18471847 // a domain.
1848 Name *string `locationName:"name" type:"string" required:"true"`
1848 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
18491849
18501850 // The version of this activity.
18511851 //
18521852 // The combination of activity type name and version must be unique with in
18531853 // a domain.
1854 Version *string `locationName:"version" type:"string" required:"true"`
1854 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
18551855
18561856 metadataActivityType `json:"-" xml:"-"`
18571857 }
19971997 // SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
19981998 type CancelTimerDecisionAttributes struct {
19991999 // Required. The unique ID of the timer to cancel.
2000 TimerId *string `locationName:"timerId" type:"string" required:"true"`
2000 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
20012001
20022002 metadataCancelTimerDecisionAttributes `json:"-" xml:"-"`
20032003 }
20332033 DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
20342034
20352035 // The timerId provided in the CancelTimer decision that failed.
2036 TimerId *string `locationName:"timerId" type:"string" required:"true"`
2036 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
20372037
20382038 metadataCancelTimerFailedEventAttributes `json:"-" xml:"-"`
20392039 }
25002500 // In order for this workflow execution to invoke AWS Lambda functions, an
25012501 // appropriate IAM role must be specified either as a default for the workflow
25022502 // type or through this field.
2503 LambdaRole *string `locationName:"lambdaRole" type:"string"`
2503 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
25042504
25052505 // The list of tags to associate with the new workflow execution. A maximum
25062506 // of 5 tags can be specified. You can list workflow executions with a specific
25352535 // at registration time then a fault will be returned.
25362536 TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`
25372537
2538 WorkflowTypeVersion *string `locationName:"workflowTypeVersion" type:"string"`
2538 WorkflowTypeVersion *string `locationName:"workflowTypeVersion" min:"1" type:"string"`
25392539
25402540 metadataContinueAsNewWorkflowExecutionDecisionAttributes `json:"-" xml:"-"`
25412541 }
26032603 CloseTimeFilter *ExecutionTimeFilter `locationName:"closeTimeFilter" type:"structure"`
26042604
26052605 // The name of the domain containing the workflow executions to count.
2606 Domain *string `locationName:"domain" type:"string" required:"true"`
2606 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
26072607
26082608 // If specified, only workflow executions matching the WorkflowId in the filter
26092609 // are counted.
26512651
26522652 type CountOpenWorkflowExecutionsInput struct {
26532653 // The name of the domain containing the workflow executions to count.
2654 Domain *string `locationName:"domain" type:"string" required:"true"`
2654 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
26552655
26562656 // If specified, only workflow executions matching the WorkflowId in the filter
26572657 // are counted.
26962696
26972697 type CountPendingActivityTasksInput struct {
26982698 // The name of the domain that contains the task list.
2699 Domain *string `locationName:"domain" type:"string" required:"true"`
2699 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
27002700
27012701 // The name of the task list.
27022702 TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
27202720
27212721 type CountPendingDecisionTasksInput struct {
27222722 // The name of the domain that contains the task list.
2723 Domain *string `locationName:"domain" type:"string" required:"true"`
2723 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
27242724
27252725 // The name of the task list.
27262726 TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
30743074 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
30753075
30763076 // The name of the domain in which the activity type is registered.
3077 Domain *string `locationName:"domain" type:"string" required:"true"`
3077 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
30783078
30793079 metadataDeprecateActivityTypeInput `json:"-" xml:"-"`
30803080 }
31133113
31143114 type DeprecateDomainInput struct {
31153115 // The name of the domain to deprecate.
3116 Name *string `locationName:"name" type:"string" required:"true"`
3116 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
31173117
31183118 metadataDeprecateDomainInput `json:"-" xml:"-"`
31193119 }
31523152
31533153 type DeprecateWorkflowTypeInput struct {
31543154 // The name of the domain in which the workflow type is registered.
3155 Domain *string `locationName:"domain" type:"string" required:"true"`
3155 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
31563156
31573157 // The workflow type to deprecate.
31583158 WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
31983198 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
31993199
32003200 // The name of the domain in which the activity type is registered.
3201 Domain *string `locationName:"domain" type:"string" required:"true"`
3201 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
32023202
32033203 metadataDescribeActivityTypeInput `json:"-" xml:"-"`
32043204 }
32523252
32533253 type DescribeDomainInput struct {
32543254 // The name of the domain to describe.
3255 Name *string `locationName:"name" type:"string" required:"true"`
3255 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
32563256
32573257 metadataDescribeDomainInput `json:"-" xml:"-"`
32583258 }
32983298
32993299 type DescribeWorkflowExecutionInput struct {
33003300 // The name of the domain containing the workflow execution.
3301 Domain *string `locationName:"domain" type:"string" required:"true"`
3301 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
33023302
33033303 // The workflow execution to describe.
33043304 Execution *WorkflowExecution `locationName:"execution" type:"structure" required:"true"`
33623362
33633363 type DescribeWorkflowTypeInput struct {
33643364 // The name of the domain in which this workflow type is registered.
3365 Domain *string `locationName:"domain" type:"string" required:"true"`
3365 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
33663366
33673367 // The workflow type to describe.
33683368 WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
34203420 // Contains the configuration settings of a domain.
34213421 type DomainConfiguration struct {
34223422 // The retention period for workflow executions in this domain.
3423 WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" type:"string" required:"true"`
3423 WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" min:"1" type:"string" required:"true"`
34243424
34253425 metadataDomainConfiguration `json:"-" xml:"-"`
34263426 }
34453445 Description *string `locationName:"description" type:"string"`
34463446
34473447 // The name of the domain. This name is unique within the account.
3448 Name *string `locationName:"name" type:"string" required:"true"`
3448 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
34493449
34503450 // The status of the domain:
34513451 //
36313631
36323632 type GetWorkflowExecutionHistoryInput struct {
36333633 // The name of the domain containing the workflow execution.
3634 Domain *string `locationName:"domain" type:"string" required:"true"`
3634 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
36353635
36363636 // Specifies the workflow execution for which to return the history.
36373637 Execution *WorkflowExecution `locationName:"execution" type:"structure" required:"true"`
41214121 DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
41224122
41234123 // The unique Amazon SWF ID for the AWS Lambda task.
4124 Id *string `locationName:"id" type:"string" required:"true"`
4124 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
41254125
41264126 // Input provided to the AWS Lambda function.
4127 Input *string `locationName:"input" type:"string"`
4127 Input *string `locationName:"input" min:"1" type:"string"`
41284128
41294129 // The name of the scheduled AWS Lambda function.
4130 Name *string `locationName:"name" type:"string" required:"true"`
4130 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
41314131
41324132 // The maximum time, in seconds, that the AWS Lambda function can take to execute
41334133 // from start to close before it is marked as failed.
42064206
42074207 type ListActivityTypesInput struct {
42084208 // The name of the domain in which the activity types have been registered.
4209 Domain *string `locationName:"domain" type:"string" required:"true"`
4209 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
42104210
42114211 // The maximum number of results that will be returned per call. nextPageToken
42124212 // can be used to obtain futher pages of results. The default is 1000, which
42184218 MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`
42194219
42204220 // If specified, only lists the activity types that have this name.
4221 Name *string `locationName:"name" type:"string"`
4221 Name *string `locationName:"name" min:"1" type:"string"`
42224222
42234223 // If a NextPageToken was returned by a previous call, there are more results
42244224 // available. To retrieve the next page of results, make the call again using
43014301 CloseTimeFilter *ExecutionTimeFilter `locationName:"closeTimeFilter" type:"structure"`
43024302
43034303 // The name of the domain that contains the workflow executions to list.
4304 Domain *string `locationName:"domain" type:"string" required:"true"`
4304 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
43054305
43064306 // If specified, only workflow executions matching the workflow ID specified
43074307 // in the filter are returned.
44434443
44444444 type ListOpenWorkflowExecutionsInput struct {
44454445 // The name of the domain that contains the workflow executions to list.
4446 Domain *string `locationName:"domain" type:"string" required:"true"`
4446 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
44474447
44484448 // If specified, only workflow executions matching the workflow ID specified
44494449 // in the filter are returned.
45084508
45094509 type ListWorkflowTypesInput struct {
45104510 // The name of the domain in which the workflow types have been registered.
4511 Domain *string `locationName:"domain" type:"string" required:"true"`
4511 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
45124512
45134513 // The maximum number of results that will be returned per call. nextPageToken
45144514 // can be used to obtain futher pages of results. The default is 1000, which
45204520 MaximumPageSize *int64 `locationName:"maximumPageSize" type:"integer"`
45214521
45224522 // If specified, lists the workflow type with this name.
4523 Name *string `locationName:"name" type:"string"`
4523 Name *string `locationName:"name" min:"1" type:"string"`
45244524
45254525 // If a NextPageToken was returned by a previous call, there are more results
45264526 // available. To retrieve the next page of results, make the call again using
45974597 Details *string `locationName:"details" type:"string"`
45984598
45994599 // The name of the marker.
4600 MarkerName *string `locationName:"markerName" type:"string" required:"true"`
4600 MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
46014601
46024602 metadataMarkerRecordedEventAttributes `json:"-" xml:"-"`
46034603 }
46444644
46454645 type PollForActivityTaskInput struct {
46464646 // The name of the domain that contains the task lists being polled.
4647 Domain *string `locationName:"domain" type:"string" required:"true"`
4647 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
46484648
46494649 // Identity of the worker making the request, recorded in the ActivityTaskStarted
46504650 // event in the workflow history. This enables diagnostic tracing when problems
46794679 // Unit of work sent to an activity worker.
46804680 type PollForActivityTaskOutput struct {
46814681 // The unique ID of the task.
4682 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
4682 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
46834683
46844684 // The type of this activity task.
46854685 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
46944694 // The opaque string used as a handle on the task. This token is used by workers
46954695 // to communicate progress and response information back to the system about
46964696 // the task.
4697 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
4697 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
46984698
46994699 // The workflow execution that started this activity task.
47004700 WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`
47184718
47194719 type PollForDecisionTaskInput struct {
47204720 // The name of the domain containing the task lists to poll.
4721 Domain *string `locationName:"domain" type:"string" required:"true"`
4721 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
47224722
47234723 // Identity of the decider making the request, which is recorded in the DecisionTaskStarted
47244724 // event in the workflow history. This enables diagnostic tracing when problems
48034803 // The opaque string used as a handle on the task. This token is used by workers
48044804 // to communicate progress and response information back to the system about
48054805 // the task.
4806 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
4806 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
48074807
48084808 // The workflow execution for which this decision task was created.
48094809 WorkflowExecution *WorkflowExecution `locationName:"workflowExecution" type:"structure" required:"true"`
48374837 // taskToken is generated by the service and should be treated as an opaque
48384838 // value. If the task is passed to another process, its taskToken must also
48394839 // be passed. This enables it to provide its progress and respond with results.
4840 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
4840 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
48414841
48424842 metadataRecordActivityTaskHeartbeatInput `json:"-" xml:"-"`
48434843 }
48984898 Details *string `locationName:"details" type:"string"`
48994899
49004900 // Required. The name of the marker.
4901 MarkerName *string `locationName:"markerName" type:"string" required:"true"`
4901 MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
49024902
49034903 metadataRecordMarkerDecisionAttributes `json:"-" xml:"-"`
49044904 }
49344934 DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
49354935
49364936 // The marker's name.
4937 MarkerName *string `locationName:"markerName" type:"string" required:"true"`
4937 MarkerName *string `locationName:"markerName" min:"1" type:"string" required:"true"`
49384938
49394939 metadataRecordMarkerFailedEventAttributes `json:"-" xml:"-"`
49404940 }
50105010 Description *string `locationName:"description" type:"string"`
50115011
50125012 // The name of the domain in which this activity is to be registered.
5013 Domain *string `locationName:"domain" type:"string" required:"true"`
5013 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
50145014
50155015 // The name of the activity type within the domain.
50165016 //
50185018 // contain a : (colon), / (slash), | (vertical bar), or any control characters
50195019 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
50205020 // string quotarnquot.
5021 Name *string `locationName:"name" type:"string" required:"true"`
5021 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
50225022
50235023 // The version of the activity type.
50245024 //
50275027 // end with whitespace. It must not contain a : (colon), / (slash), | (vertical
50285028 // bar), or any control characters (\u0000-\u001f | \u007f - \u009f). Also,
50295029 // it must not contain the literal string quotarnquot.
5030 Version *string `locationName:"version" type:"string" required:"true"`
5030 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
50315031
50325032 metadataRegisterActivityTypeInput `json:"-" xml:"-"`
50335033 }
50755075 // contain a : (colon), / (slash), | (vertical bar), or any control characters
50765076 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
50775077 // string quotarnquot.
5078 Name *string `locationName:"name" type:"string" required:"true"`
5078 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
50795079
50805080 // The duration (in days) that records and histories of workflow executions
50815081 // on the domain should be kept by the service. After the retention period,
50885088 // The maximum workflow execution retention period is 90 days. For more information
50895089 // about Amazon SWF service limits, see: Amazon SWF Service Limits (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-limits.html)
50905090 // in the Amazon SWF Developer Guide.
5091 WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" type:"string" required:"true"`
5091 WorkflowExecutionRetentionPeriodInDays *string `locationName:"workflowExecutionRetentionPeriodInDays" min:"1" type:"string" required:"true"`
50925092
50935093 metadataRegisterDomainInput `json:"-" xml:"-"`
50945094 }
51585158 // This default can be overridden when starting a workflow execution using
51595159 // the StartWorkflowExecution action or the StartChildWorkflowExecution and
51605160 // ContinueAsNewWorkflowExecution decision.
5161 DefaultLambdaRole *string `locationName:"defaultLambdaRole" type:"string"`
5161 DefaultLambdaRole *string `locationName:"defaultLambdaRole" min:"1" type:"string"`
51625162
51635163 // If set, specifies the default task list to use for scheduling decision tasks
51645164 // for executions of this workflow type. This default is used only if a task
51895189 Description *string `locationName:"description" type:"string"`
51905190
51915191 // The name of the domain in which to register the workflow type.
5192 Domain *string `locationName:"domain" type:"string" required:"true"`
5192 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
51935193
51945194 // The name of the workflow type.
51955195 //
51975197 // contain a : (colon), / (slash), | (vertical bar), or any control characters
51985198 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
51995199 // string quotarnquot.
5200 Name *string `locationName:"name" type:"string" required:"true"`
5200 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
52015201
52025202 // The version of the workflow type.
52035203 //
52075207 // not start or end with whitespace. It must not contain a : (colon), / (slash),
52085208 // | (vertical bar), or any control characters (\u0000-\u001f | \u007f - \u009f).
52095209 // Also, it must not contain the literal string quotarnquot.
5210 Version *string `locationName:"version" type:"string" required:"true"`
5210 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
52115211
52125212 metadataRegisterWorkflowTypeInput `json:"-" xml:"-"`
52135213 }
52615261 // SWF Workflows (http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html).
52625262 type RequestCancelActivityTaskDecisionAttributes struct {
52635263 // The activityId of the activity task to be canceled.
5264 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
5264 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
52655265
52665266 metadataRequestCancelActivityTaskDecisionAttributes `json:"-" xml:"-"`
52675267 }
52835283 // Provides details of the RequestCancelActivityTaskFailed event.
52845284 type RequestCancelActivityTaskFailedEventAttributes struct {
52855285 // The activityId provided in the RequestCancelActivityTask decision that failed.
5286 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
5286 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
52875287
52885288 // The cause of the failure. This information is generated by the system and
52895289 // can be useful for diagnostic purposes.
53405340 RunId *string `locationName:"runId" type:"string"`
53415341
53425342 // Required. The workflowId of the external workflow execution to cancel.
5343 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
5343 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
53445344
53455345 metadataRequestCancelExternalWorkflowExecutionDecisionAttributes `json:"-" xml:"-"`
53465346 }
53885388
53895389 // The workflowId of the external workflow to which the cancel request was to
53905390 // be delivered.
5391 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
5391 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
53925392
53935393 metadataRequestCancelExternalWorkflowExecutionFailedEventAttributes `json:"-" xml:"-"`
53945394 }
54235423 RunId *string `locationName:"runId" type:"string"`
54245424
54255425 // The workflowId of the external workflow execution to be canceled.
5426 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
5426 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
54275427
54285428 metadataRequestCancelExternalWorkflowExecutionInitiatedEventAttributes `json:"-" xml:"-"`
54295429 }
54445444
54455445 type RequestCancelWorkflowExecutionInput struct {
54465446 // The name of the domain containing the workflow execution to cancel.
5447 Domain *string `locationName:"domain" type:"string" required:"true"`
5447 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
54485448
54495449 // The runId of the workflow execution to cancel.
54505450 RunId *string `locationName:"runId" type:"string"`
54515451
54525452 // The workflowId of the workflow execution to cancel.
5453 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
5453 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
54545454
54555455 metadataRequestCancelWorkflowExecutionInput `json:"-" xml:"-"`
54565456 }
54965496 // taskToken is generated by the service and should be treated as an opaque
54975497 // value. If the task is passed to another process, its taskToken must also
54985498 // be passed. This enables it to provide its progress and respond with results.
5499 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
5499 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
55005500
55015501 metadataRespondActivityTaskCanceledInput `json:"-" xml:"-"`
55025502 }
55435543 // taskToken is generated by the service and should be treated as an opaque
55445544 // value. If the task is passed to another process, its taskToken must also
55455545 // be passed. This enables it to provide its progress and respond with results.
5546 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
5546 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
55475547
55485548 metadataRespondActivityTaskCompletedInput `json:"-" xml:"-"`
55495549 }
55925592 // taskToken is generated by the service and should be treated as an opaque
55935593 // value. If the task is passed to another process, its taskToken must also
55945594 // be passed. This enables it to provide its progress and respond with results.
5595 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
5595 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
55965596
55975597 metadataRespondActivityTaskFailedInput `json:"-" xml:"-"`
55985598 }
56425642 // taskToken is generated by the service and should be treated as an opaque
56435643 // value. If the task is passed to another process, its taskToken must also
56445644 // be passed. This enables it to provide its progress and respond with results.
5645 TaskToken *string `locationName:"taskToken" type:"string" required:"true"`
5645 TaskToken *string `locationName:"taskToken" min:"1" type:"string" required:"true"`
56465646
56475647 metadataRespondDecisionTaskCompletedInput `json:"-" xml:"-"`
56485648 }
57045704 // contain a : (colon), / (slash), | (vertical bar), or any control characters
57055705 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
57065706 // string quotarnquot.
5707 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
5707 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
57085708
57095709 // Required. The type of the activity task to schedule.
57105710 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
58085808 // Provides details of the ScheduleActivityTaskFailed event.
58095809 type ScheduleActivityTaskFailedEventAttributes struct {
58105810 // The activityId provided in the ScheduleActivityTask decision that failed.
5811 ActivityId *string `locationName:"activityId" type:"string" required:"true"`
5811 ActivityId *string `locationName:"activityId" min:"1" type:"string" required:"true"`
58125812
58135813 // The activity type provided in the ScheduleActivityTask decision that failed.
58145814 ActivityType *ActivityType `locationName:"activityType" type:"structure" required:"true"`
58695869 // contain a : (colon), / (slash), | (vertical bar), or any control characters
58705870 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
58715871 // string quotarnquot.
5872 Id *string `locationName:"id" type:"string" required:"true"`
5872 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
58735873
58745874 // The input provided to the AWS Lambda function.
5875 Input *string `locationName:"input" type:"string"`
5875 Input *string `locationName:"input" min:"1" type:"string"`
58765876
58775877 // Required. The name of the AWS Lambda function to invoke.
5878 Name *string `locationName:"name" type:"string" required:"true"`
5878 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
58795879
58805880 // If set, specifies the maximum duration the function may take to execute.
58815881 StartToCloseTimeout *string `locationName:"startToCloseTimeout" type:"string"`
59145914 DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
59155915
59165916 // The unique Amazon SWF ID of the AWS Lambda task.
5917 Id *string `locationName:"id" type:"string" required:"true"`
5917 Id *string `locationName:"id" min:"1" type:"string" required:"true"`
59185918
59195919 // The name of the scheduled AWS Lambda function.
5920 Name *string `locationName:"name" type:"string" required:"true"`
5920 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
59215921
59225922 metadataScheduleLambdaFunctionFailedEventAttributes `json:"-" xml:"-"`
59235923 }
59655965
59665966 // Required. The name of the signal.The target workflow execution will use the
59675967 // signal name and input to process the signal.
5968 SignalName *string `locationName:"signalName" type:"string" required:"true"`
5968 SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`
59695969
59705970 // Required. The workflowId of the workflow execution to be signaled.
5971 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
5971 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
59725972
59735973 metadataSignalExternalWorkflowExecutionDecisionAttributes `json:"-" xml:"-"`
59745974 }
60176017
60186018 // The workflowId of the external workflow execution that the signal was being
60196019 // delivered to.
6020 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6020 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
60216021
60226022 metadataSignalExternalWorkflowExecutionFailedEventAttributes `json:"-" xml:"-"`
60236023 }
60556055 RunId *string `locationName:"runId" type:"string"`
60566056
60576057 // The name of the signal.
6058 SignalName *string `locationName:"signalName" type:"string" required:"true"`
6058 SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`
60596059
60606060 // The workflowId of the external workflow execution.
6061 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6061 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
60626062
60636063 metadataSignalExternalWorkflowExecutionInitiatedEventAttributes `json:"-" xml:"-"`
60646064 }
60796079
60806080 type SignalWorkflowExecutionInput struct {
60816081 // The name of the domain containing the workflow execution to signal.
6082 Domain *string `locationName:"domain" type:"string" required:"true"`
6082 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
60836083
60846084 // Data to attach to the WorkflowExecutionSignaled event in the target workflow
60856085 // execution's history.
60896089 RunId *string `locationName:"runId" type:"string"`
60906090
60916091 // The name of the signal. This name must be meaningful to the target workflow.
6092 SignalName *string `locationName:"signalName" type:"string" required:"true"`
6092 SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`
60936093
60946094 // The workflowId of the workflow execution to signal.
6095 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6095 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
60966096
60976097 metadataSignalWorkflowExecutionInput `json:"-" xml:"-"`
60986098 }
61916191 // In order for this workflow execution to invoke AWS Lambda functions, an
61926192 // appropriate IAM role must be specified either as a default for the workflow
61936193 // type or through this field.
6194 LambdaRole *string `locationName:"lambdaRole" type:"string"`
6194 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
61956195
61966196 // The list of tags to associate with the child workflow execution. A maximum
61976197 // of 5 tags can be specified. You can list workflow executions with a specific
62416241 // contain a : (colon), / (slash), | (vertical bar), or any control characters
62426242 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
62436243 // string quotarnquot.
6244 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6244 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
62456245
62466246 // Required. The type of the workflow execution to be started.
62476247 WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
62886288 InitiatedEventId *int64 `locationName:"initiatedEventId" type:"long" required:"true"`
62896289
62906290 // The workflowId of the child workflow execution.
6291 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6291 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
62926292
62936293 // The workflow type provided in the StartChildWorkflowExecution decision that
62946294 // failed.
63486348
63496349 // The IAM role attached to this workflow execution to use when invoking AWS
63506350 // Lambda functions.
6351 LambdaRole *string `locationName:"lambdaRole" type:"string"`
6351 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
63526352
63536353 // The list of tags to associated with the child workflow execution.
63546354 TagList []*string `locationName:"tagList" type:"list"`
63746374 TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string"`
63756375
63766376 // The workflowId of the child workflow execution.
6377 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6377 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
63786378
63796379 // The type of the child workflow execution.
63806380 WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
64556455 //
64566456 // The duration is specified in seconds; an integer greater than or equal to
64576457 // 0.
6458 StartToFireTimeout *string `locationName:"startToFireTimeout" type:"string" required:"true"`
6458 StartToFireTimeout *string `locationName:"startToFireTimeout" min:"1" type:"string" required:"true"`
64596459
64606460 // Required. The unique ID of the timer.
64616461 //
64636463 // contain a : (colon), / (slash), | (vertical bar), or any control characters
64646464 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
64656465 // string quotarnquot.
6466 TimerId *string `locationName:"timerId" type:"string" required:"true"`
6466 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
64676467
64686468 metadataStartTimerDecisionAttributes `json:"-" xml:"-"`
64696469 }
64996499 DecisionTaskCompletedEventId *int64 `locationName:"decisionTaskCompletedEventId" type:"long" required:"true"`
65006500
65016501 // The timerId provided in the StartTimer decision that failed.
6502 TimerId *string `locationName:"timerId" type:"string" required:"true"`
6502 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
65036503
65046504 metadataStartTimerFailedEventAttributes `json:"-" xml:"-"`
65056505 }
65386538 ChildPolicy *string `locationName:"childPolicy" type:"string" enum:"ChildPolicy"`
65396539
65406540 // The name of the domain in which the workflow execution is created.
6541 Domain *string `locationName:"domain" type:"string" required:"true"`
6541 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
65426542
65436543 // The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout
65446544 // specified when registering the workflow type.
65656565 // In order for this workflow execution to invoke AWS Lambda functions, an
65666566 // appropriate IAM role must be specified either as a default for the workflow
65676567 // type or through this field.
6568 LambdaRole *string `locationName:"lambdaRole" type:"string"`
6568 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
65696569
65706570 // The list of tags to associate with the workflow execution. You can specify
65716571 // a maximum of 5 tags. You can list workflow executions with a specific tag
66216621 // contain a : (colon), / (slash), | (vertical bar), or any control characters
66226622 // (\u0000-\u001f | \u007f - \u009f). Also, it must not contain the literal
66236623 // string quotarnquot.
6624 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6624 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
66256625
66266626 // The type of the workflow to start.
66276627 WorkflowType *WorkflowType `locationName:"workflowType" type:"structure" required:"true"`
66476647 type StartWorkflowExecutionOutput struct {
66486648 // The runId of a workflow execution. This ID is generated by the service and
66496649 // can be used to uniquely identify the workflow execution within a domain.
6650 RunId *string `locationName:"runId" type:"string"`
6650 RunId *string `locationName:"runId" min:"1" type:"string"`
66516651
66526652 metadataStartWorkflowExecutionOutput `json:"-" xml:"-"`
66536653 }
66706670 type TagFilter struct {
66716671 // Required. Specifies the tag that must be associated with the execution for
66726672 // it to meet the filter criteria.
6673 Tag *string `locationName:"tag" type:"string" required:"true"`
6673 Tag *string `locationName:"tag" min:"1" type:"string" required:"true"`
66746674
66756675 metadataTagFilter `json:"-" xml:"-"`
66766676 }
66926692 // Represents a task list.
66936693 type TaskList struct {
66946694 // The name of the task list.
6695 Name *string `locationName:"name" type:"string" required:"true"`
6695 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
66966696
66976697 metadataTaskList `json:"-" xml:"-"`
66986698 }
67346734 Details *string `locationName:"details" type:"string"`
67356735
67366736 // The domain of the workflow execution to terminate.
6737 Domain *string `locationName:"domain" type:"string" required:"true"`
6737 Domain *string `locationName:"domain" min:"1" type:"string" required:"true"`
67386738
67396739 // Optional. A descriptive reason for terminating the workflow execution.
67406740 Reason *string `locationName:"reason" type:"string"`
67436743 RunId *string `locationName:"runId" type:"string"`
67446744
67456745 // The workflowId of the workflow execution to terminate.
6746 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6746 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
67476747
67486748 metadataTerminateWorkflowExecutionInput `json:"-" xml:"-"`
67496749 }
67946794 StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
67956795
67966796 // The unique ID of the timer that was canceled.
6797 TimerId *string `locationName:"timerId" type:"string" required:"true"`
6797 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
67986798
67996799 metadataTimerCanceledEventAttributes `json:"-" xml:"-"`
68006800 }
68216821 StartedEventId *int64 `locationName:"startedEventId" type:"long" required:"true"`
68226822
68236823 // The unique ID of the timer that fired.
6824 TimerId *string `locationName:"timerId" type:"string" required:"true"`
6824 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
68256825
68266826 metadataTimerFiredEventAttributes `json:"-" xml:"-"`
68276827 }
68566856 //
68576857 // The duration is specified in seconds; an integer greater than or equal to
68586858 // 0.
6859 StartToFireTimeout *string `locationName:"startToFireTimeout" type:"string" required:"true"`
6859 StartToFireTimeout *string `locationName:"startToFireTimeout" min:"1" type:"string" required:"true"`
68606860
68616861 // The unique ID of the timer that was started.
6862 TimerId *string `locationName:"timerId" type:"string" required:"true"`
6862 TimerId *string `locationName:"timerId" min:"1" type:"string" required:"true"`
68636863
68646864 metadataTimerStartedEventAttributes `json:"-" xml:"-"`
68656865 }
68816881 // Represents a workflow execution.
68826882 type WorkflowExecution struct {
68836883 // A system-generated unique identifier for the workflow execution.
6884 RunId *string `locationName:"runId" type:"string" required:"true"`
6884 RunId *string `locationName:"runId" min:"1" type:"string" required:"true"`
68856885
68866886 // The user defined identifier associated with the workflow execution.
6887 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
6887 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
68886888
68896889 metadataWorkflowExecution `json:"-" xml:"-"`
68906890 }
70157015 //
70167016 // The duration is specified in seconds; an integer greater than or equal to
70177017 // 0. The value "NONE" can be used to specify unlimited duration.
7018 ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" type:"string" required:"true"`
7018 ExecutionStartToCloseTimeout *string `locationName:"executionStartToCloseTimeout" min:"1" type:"string" required:"true"`
70197019
70207020 // The IAM role used by this workflow execution when invoking AWS Lambda functions.
7021 LambdaRole *string `locationName:"lambdaRole" type:"string"`
7021 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
70227022
70237023 // The task list used for the decision tasks generated for this workflow execution.
70247024 TaskList *TaskList `locationName:"taskList" type:"structure" required:"true"`
70367036 //
70377037 // The duration is specified in seconds; an integer greater than or equal to
70387038 // 0. The value "NONE" can be used to specify unlimited duration.
7039 TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" type:"string" required:"true"`
7039 TaskStartToCloseTimeout *string `locationName:"taskStartToCloseTimeout" min:"1" type:"string" required:"true"`
70407040
70417041 metadataWorkflowExecutionConfiguration `json:"-" xml:"-"`
70427042 }
70877087
70887088 // The IAM role attached to this workflow execution to use when invoking AWS
70897089 // Lambda functions.
7090 LambdaRole *string `locationName:"lambdaRole" type:"string"`
7090 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
70917091
70927092 // The runId of the new workflow execution.
7093 NewExecutionRunId *string `locationName:"newExecutionRunId" type:"string" required:"true"`
7093 NewExecutionRunId *string `locationName:"newExecutionRunId" min:"1" type:"string" required:"true"`
70947094
70957095 // The list of tags associated with the new workflow execution.
70967096 TagList []*string `locationName:"tagList" type:"list"`
71877187 // Used to filter the workflow executions in visibility APIs by their workflowId.
71887188 type WorkflowExecutionFilter struct {
71897189 // The workflowId to pass of match the criteria of this filter.
7190 WorkflowId *string `locationName:"workflowId" type:"string" required:"true"`
7190 WorkflowId *string `locationName:"workflowId" min:"1" type:"string" required:"true"`
71917191
71927192 metadataWorkflowExecutionFilter `json:"-" xml:"-"`
71937193 }
73527352
73537353 // The name of the signal received. The decider can use the signal name and
73547354 // inputs to determine how to the process the signal.
7355 SignalName *string `locationName:"signalName" type:"string" required:"true"`
7355 SignalName *string `locationName:"signalName" min:"1" type:"string" required:"true"`
73567356
73577357 metadataWorkflowExecutionSignaledEventAttributes `json:"-" xml:"-"`
73587358 }
74027402
74037403 // The IAM role attached to this workflow execution to use when invoking AWS
74047404 // Lambda functions.
7405 LambdaRole *string `locationName:"lambdaRole" type:"string"`
7405 LambdaRole *string `locationName:"lambdaRole" min:"1" type:"string"`
74067406
74077407 // The ID of the StartChildWorkflowExecutionInitiated event corresponding to
74087408 // the StartChildWorkflowExecution decision to start this workflow execution.
75317531 //
75327532 // The combination of workflow type name and version must be unique with in
75337533 // a domain.
7534 Name *string `locationName:"name" type:"string" required:"true"`
7534 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
75357535
75367536 // Required. The version of the workflow type.
75377537 //
75387538 // The combination of workflow type name and version must be unique with in
75397539 // a domain.
7540 Version *string `locationName:"version" type:"string" required:"true"`
7540 Version *string `locationName:"version" min:"1" type:"string" required:"true"`
75417541
75427542 metadataWorkflowType `json:"-" xml:"-"`
75437543 }
75847584
75857585 // The default IAM role to use when a workflow execution invokes a AWS Lambda
75867586 // function.
7587 DefaultLambdaRole *string `locationName:"defaultLambdaRole" type:"string"`
7587 DefaultLambdaRole *string `locationName:"defaultLambdaRole" min:"1" type:"string"`
75887588
75897589 // Optional. The default task list, specified when registering the workflow
75907590 // type, for decisions tasks scheduled for workflow executions of this type.
76387638 // if specified, defines a rule that must be satisfied by each returned result.
76397639 type WorkflowTypeFilter struct {
76407640 // Required. Name of the workflow type.
7641 Name *string `locationName:"name" type:"string" required:"true"`
7641 Name *string `locationName:"name" min:"1" type:"string" required:"true"`
76427642
76437643 // Version of the workflow type.
76447644 Version *string `locationName:"version" type:"string"`
+21
-21
service/workspaces/api.go less more
316316 // Contains the inputs for the CreateWorkspaces operation.
317317 type CreateWorkspacesInput struct {
318318 // An array of structures that specify the WorkSpaces to create.
319 Workspaces []*WorkspaceRequest `type:"list" required:"true"`
319 Workspaces []*WorkspaceRequest `min:"1" type:"list" required:"true"`
320320
321321 metadataCreateWorkspacesInput `json:"-" xml:"-"`
322322 }
405405 type DescribeWorkspaceBundlesInput struct {
406406 // An array of strings that contains the identifiers of the bundles to retrieve.
407407 // This parameter cannot be combined with any other filter parameter.
408 BundleIds []*string `type:"list"`
408 BundleIds []*string `min:"1" type:"list"`
409409
410410 // The NextToken value from a previous call to this operation. Pass null if
411411 // this is the first call.
412 NextToken *string `type:"string"`
412 NextToken *string `min:"1" type:"string"`
413413
414414 // The owner of the bundles to retrieve. This parameter cannot be combined with
415415 // any other filter parameter.
445445 // If not null, more results are available. Pass this value for the NextToken
446446 // parameter in a subsequent call to this operation to retrieve the next set
447447 // of items. This token is valid for one day and must be used within that timeframe.
448 NextToken *string `type:"string"`
448 NextToken *string `min:"1" type:"string"`
449449
450450 metadataDescribeWorkspaceBundlesOutput `json:"-" xml:"-"`
451451 }
468468 type DescribeWorkspaceDirectoriesInput struct {
469469 // An array of strings that contains the directory identifiers to retrieve information
470470 // for. If this member is null, all directories are retrieved.
471 DirectoryIds []*string `type:"list"`
471 DirectoryIds []*string `min:"1" type:"list"`
472472
473473 // The NextToken value from a previous call to this operation. Pass null if
474474 // this is the first call.
475 NextToken *string `type:"string"`
475 NextToken *string `min:"1" type:"string"`
476476
477477 metadataDescribeWorkspaceDirectoriesInput `json:"-" xml:"-"`
478478 }
499499 // If not null, more results are available. Pass this value for the NextToken
500500 // parameter in a subsequent call to this operation to retrieve the next set
501501 // of items. This token is valid for one day and must be used within that timeframe.
502 NextToken *string `type:"string"`
502 NextToken *string `min:"1" type:"string"`
503503
504504 metadataDescribeWorkspaceDirectoriesOutput `json:"-" xml:"-"`
505505 }
531531 DirectoryId *string `type:"string"`
532532
533533 // The maximum number of items to return.
534 Limit *int64 `type:"integer"`
534 Limit *int64 `min:"1" type:"integer"`
535535
536536 // The NextToken value from a previous call to this operation. Pass null if
537537 // this is the first call.
538 NextToken *string `type:"string"`
538 NextToken *string `min:"1" type:"string"`
539539
540540 // Used with the DirectoryId parameter to specify the directory user for which
541541 // to obtain the WorkSpace.
542 UserName *string `type:"string"`
542 UserName *string `min:"1" type:"string"`
543543
544544 // An array of strings that contain the identifiers of the WorkSpaces for which
545545 // to retrieve information. This parameter cannot be combined with any other
548548 // Because the CreateWorkspaces operation is asynchronous, the identifier returned
549549 // by CreateWorkspaces is not immediately available. If you immediately call
550550 // DescribeWorkspaces with this identifier, no information will be returned.
551 WorkspaceIds []*string `type:"list"`
551 WorkspaceIds []*string `min:"1" type:"list"`
552552
553553 metadataDescribeWorkspacesInput `json:"-" xml:"-"`
554554 }
572572 // If not null, more results are available. Pass this value for the NextToken
573573 // parameter in a subsequent call to this operation to retrieve the next set
574574 // of items. This token is valid for one day and must be used within that timeframe.
575 NextToken *string `type:"string"`
575 NextToken *string `min:"1" type:"string"`
576576
577577 // An array of structures that contain the information about the WorkSpaces.
578578 //
681681 // Contains the inputs for the RebootWorkspaces operation.
682682 type RebootWorkspacesInput struct {
683683 // An array of structures that specify the WorkSpaces to reboot.
684 RebootWorkspaceRequests []*RebootRequest `type:"list" required:"true"`
684 RebootWorkspaceRequests []*RebootRequest `min:"1" type:"list" required:"true"`
685685
686686 metadataRebootWorkspacesInput `json:"-" xml:"-"`
687687 }
748748 // Contains the inputs for the RebuildWorkspaces operation.
749749 type RebuildWorkspacesInput struct {
750750 // An array of structures that specify the WorkSpaces to rebuild.
751 RebuildWorkspaceRequests []*RebuildRequest `type:"list" required:"true"`
751 RebuildWorkspaceRequests []*RebuildRequest `min:"1" type:"list" required:"true"`
752752
753753 metadataRebuildWorkspacesInput `json:"-" xml:"-"`
754754 }
815815 // Contains the inputs for the TerminateWorkspaces operation.
816816 type TerminateWorkspacesInput struct {
817817 // An array of structures that specify the WorkSpaces to terminate.
818 TerminateWorkspaceRequests []*TerminateRequest `type:"list" required:"true"`
818 TerminateWorkspaceRequests []*TerminateRequest `min:"1" type:"list" required:"true"`
819819
820820 metadataTerminateWorkspacesInput `json:"-" xml:"-"`
821821 }
859859 // Contains information about the user storage for a WorkSpace bundle.
860860 type UserStorage struct {
861861 // The amount of user storage for the bundle.
862 Capacity *string `type:"string"`
862 Capacity *string `min:"1" type:"string"`
863863
864864 metadataUserStorage `json:"-" xml:"-"`
865865 }
904904 SubnetId *string `type:"string"`
905905
906906 // The user that the WorkSpace is assigned to.
907 UserName *string `type:"string"`
907 UserName *string `min:"1" type:"string"`
908908
909909 // The identifier of the WorkSpace.
910910 WorkspaceId *string `type:"string"`
938938 Description *string `type:"string"`
939939
940940 // The name of the bundle.
941 Name *string `type:"string"`
941 Name *string `min:"1" type:"string"`
942942
943943 // The owner of the bundle. This contains the owner's account identifier, or
944944 // AMAZON if the bundle is provided by AWS.
972972 Alias *string `type:"string"`
973973
974974 // The user name for the service account.
975 CustomerUserName *string `type:"string"`
975 CustomerUserName *string `min:"1" type:"string"`
976976
977977 // The directory identifier.
978978 DirectoryId *string `type:"string"`
993993
994994 // The registration code for the directory. This is the code that users enter
995995 // in their Amazon WorkSpaces client application to connect to the directory.
996 RegistrationCode *string `type:"string"`
996 RegistrationCode *string `min:"1" type:"string"`
997997
998998 // The state of the directory's registration with Amazon WorkSpaces
999999 State *string `type:"string" enum:"WorkspaceDirectoryState"`
10401040
10411041 // The username that the WorkSpace is assigned to. This username must exist
10421042 // in the AWS Directory Service directory specified by the DirectoryId member.
1043 UserName *string `type:"string" required:"true"`
1043 UserName *string `min:"1" type:"string" required:"true"`
10441044
10451045 metadataWorkspaceRequest `json:"-" xml:"-"`
10461046 }