Skip to content

Commit

Permalink
feat(client-ec2): Documentation updates for EC2.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Feb 2, 2023
1 parent 1f89298 commit 3ff7382
Show file tree
Hide file tree
Showing 16 changed files with 138 additions and 82 deletions.
14 changes: 7 additions & 7 deletions clients/client-ec2/src/EC2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3702,7 +3702,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public associateIpamResourceDiscovery(
args: AssociateIpamResourceDiscoveryCommandInput,
Expand Down Expand Up @@ -5747,7 +5747,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public createIpamResourceDiscovery(
args: CreateIpamResourceDiscoveryCommandInput,
Expand Down Expand Up @@ -8516,7 +8516,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public deleteIpamResourceDiscovery(
args: DeleteIpamResourceDiscoveryCommandInput,
Expand Down Expand Up @@ -12641,7 +12641,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public describeIpamResourceDiscoveries(
args: DescribeIpamResourceDiscoveriesCommandInput,
Expand Down Expand Up @@ -16601,7 +16601,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public disassociateIpamResourceDiscovery(
args: DisassociateIpamResourceDiscoveryCommandInput,
Expand Down Expand Up @@ -18264,7 +18264,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public getIpamResourceCidrs(
args: GetIpamResourceCidrsCommandInput,
Expand Down Expand Up @@ -20220,7 +20220,7 @@ export class EC2 extends EC2Client {
}

/**
* <p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
public modifyIpamResourceDiscovery(
args: ModifyIpamResourceDiscoveryCommandInput,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface AssociateIpamResourceDiscoveryCommandOutput
__MetadataBearer {}

/**
* <p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface CreateIpamResourceDiscoveryCommandInput extends CreateIpamResou
export interface CreateIpamResourceDiscoveryCommandOutput extends CreateIpamResourceDiscoveryResult, __MetadataBearer {}

/**
* <p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface DeleteIpamResourceDiscoveryCommandInput extends DeleteIpamResou
export interface DeleteIpamResourceDiscoveryCommandOutput extends DeleteIpamResourceDiscoveryResult, __MetadataBearer {}

/**
* <p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface DescribeIpamResourceDiscoveriesCommandOutput
__MetadataBearer {}

/**
* <p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface DisassociateIpamResourceDiscoveryCommandOutput
__MetadataBearer {}

/**
* <p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface GetIpamResourceCidrsCommandInput extends GetIpamResourceCidrsRe
export interface GetIpamResourceCidrsCommandOutput extends GetIpamResourceCidrsResult, __MetadataBearer {}

/**
* <p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface ModifyIpamResourceDiscoveryCommandInput extends ModifyIpamResou
export interface ModifyIpamResourceDiscoveryCommandOutput extends ModifyIpamResourceDiscoveryResult, __MetadataBearer {}

/**
* <p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
17 changes: 9 additions & 8 deletions clients/client-ec2/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -763,7 +763,7 @@ export interface AcceptVpcPeeringConnectionRequest {
* <p>The ID of the VPC peering connection. You must specify this parameter in the
* request.</p>
*/
VpcPeeringConnectionId?: string;
VpcPeeringConnectionId: string | undefined;
}

/**
Expand Down Expand Up @@ -2913,13 +2913,13 @@ export interface AssociateEnclaveCertificateIamRoleRequest {
/**
* <p>The ARN of the ACM certificate with which to associate the IAM role.</p>
*/
CertificateArn?: string;
CertificateArn: string | undefined;

/**
* <p>The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM
* certificate.</p>
*/
RoleArn?: string;
RoleArn: string | undefined;

/**
* <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>
Expand Down Expand Up @@ -3517,17 +3517,17 @@ export interface AssociateTransitGatewayMulticastDomainRequest {
/**
* <p>The ID of the transit gateway multicast domain.</p>
*/
TransitGatewayMulticastDomainId?: string;
TransitGatewayMulticastDomainId: string | undefined;

/**
* <p>The ID of the transit gateway attachment to associate with the transit gateway multicast domain.</p>
*/
TransitGatewayAttachmentId?: string;
TransitGatewayAttachmentId: string | undefined;

/**
* <p>The IDs of the subnets to associate with the transit gateway multicast domain.</p>
*/
SubnetIds?: string[];
SubnetIds: string[] | undefined;

/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
Expand Down Expand Up @@ -4906,8 +4906,9 @@ export interface AuthorizeSecurityGroupIngressResult {
export interface S3Storage {
/**
* <p>The access key ID of the owner of the bucket. Before you specify a value for your access
* key ID, review and follow the guidance in <a href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html">Best practices for managing
* Amazon Web Services access keys</a>.</p>
* key ID, review and follow the guidance in <a href="https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html">Best
* Practices for Amazon Web Services accounts</a> in the <i>Account ManagementReference
* Guide</i>.</p>
*/
AWSAccessKeyId?: string;

Expand Down
11 changes: 8 additions & 3 deletions clients/client-ec2/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2032,6 +2032,7 @@ export interface CreateFleetRequest {
/**
* <p>Indicates whether running instances should be terminated if the total target capacity of
* the EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>
* <p>Supported only for fleets of type <code>maintain</code>.</p>
*/
ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string;

Expand Down Expand Up @@ -3183,6 +3184,11 @@ export interface EbsBlockDevice {
* <p>Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For
* more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances">Supported instance types</a>.</p>
* <p>This parameter is not returned by <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute.html">DescribeImageAttribute</a>.</p>
* <p>For <a>CreateImage</a> and <a>RegisterImage</a>, you can specify this
* parameter only for block device mappings that result in new, empty volumes when instances are
* launched from the image. Omit this parameter on block device mappings that include an existing
* volume or snapshot. If you include this parameter, and specify an encryption setting that is
* different from the existing volume or snapshot, the request will fail.</p>
*/
Encrypted?: boolean;
}
Expand Down Expand Up @@ -4088,7 +4094,7 @@ export enum IpamResourceDiscoveryState {
}

/**
* <p>A resource discovery is an IPAM component that enables IPAM Service to manage and monitor resources that belong to the owning account.</p>
* <p>A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.</p>
*/
export interface IpamResourceDiscovery {
/**
Expand Down Expand Up @@ -5218,8 +5224,7 @@ export interface RequestLaunchTemplateData {
* </p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#use-an-ssm-parameter-instead-of-an-ami-id">Use a Systems
* Manager parameter instead of an AMI ID</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html#using-systems-manager-parameter-to-find-AMI">Use a Systems Manager parameter to find an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
*/
ImageId?: string;

Expand Down
5 changes: 4 additions & 1 deletion clients/client-ec2/src/models/models_2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3263,6 +3263,9 @@ export interface CreateVolumeRequest {
* </p>
* </li>
* </ul>
* <important>
* <p>Throughput Optimized HDD (<code>st1</code>) and Cold HDD (<code>sc1</code>) volumes can't be used as boot volumes.</p>
* </important>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the
* <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
* <p>Default: <code>gp2</code>
Expand Down Expand Up @@ -4120,7 +4123,7 @@ export interface CreateVpcPeeringConnectionRequest {
* <p>The ID of the requester VPC. You must specify this parameter in the
* request.</p>
*/
VpcId?: string;
VpcId: string | undefined;

/**
* <p>The Region code for the accepter VPC, if the accepter VPC is located in a Region
Expand Down
1 change: 1 addition & 0 deletions clients/client-ec2/src/models/models_3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4626,6 +4626,7 @@ export interface FleetData {
/**
* <p>Indicates whether running instances should be terminated if the target capacity of the
* EC2 Fleet is decreased below the current size of the EC2 Fleet.</p>
* <p>Supported only for fleets of type <code>maintain</code>.</p>
*/
ExcessCapacityTerminationPolicy?: FleetExcessCapacityTerminationPolicy | string;

Expand Down
6 changes: 3 additions & 3 deletions clients/client-ec2/src/models/models_4.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6878,9 +6878,9 @@ export interface SpotFleetRequestConfigData {
ClientToken?: string;

/**
* <p>Indicates whether running Spot Instances should be terminated if you decrease the
* target capacity of the Spot Fleet request below the current size of the Spot
* Fleet.</p>
* <p>Indicates whether running instances should be terminated if you decrease the
* target capacity of the Spot Fleet request below the current size of the Spot Fleet.</p>
* <p>Supported only for fleets of type <code>maintain</code>.</p>
*/
ExcessCapacityTerminationPolicy?: ExcessCapacityTerminationPolicy | string;

Expand Down
14 changes: 7 additions & 7 deletions clients/client-ec2/src/models/models_5.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2006,12 +2006,12 @@ export interface DisassociateEnclaveCertificateIamRoleRequest {
/**
* <p>The ARN of the ACM certificate from which to disassociate the IAM role.</p>
*/
CertificateArn?: string;
CertificateArn: string | undefined;

/**
* <p>The ARN of the IAM role to disassociate.</p>
*/
RoleArn?: string;
RoleArn: string | undefined;

/**
* <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>
Expand Down Expand Up @@ -2181,17 +2181,17 @@ export interface DisassociateTransitGatewayMulticastDomainRequest {
/**
* <p>The ID of the transit gateway multicast domain.</p>
*/
TransitGatewayMulticastDomainId?: string;
TransitGatewayMulticastDomainId: string | undefined;

/**
* <p>The ID of the attachment.</p>
*/
TransitGatewayAttachmentId?: string;
TransitGatewayAttachmentId: string | undefined;

/**
* <p>The IDs of the subnets;</p>
*/
SubnetIds?: string[];
SubnetIds: string[] | undefined;

/**
* <p>Checks whether you have the required permissions for the action, without actually making the request,
Expand Down Expand Up @@ -3111,7 +3111,7 @@ export interface GetAssociatedEnclaveCertificateIamRolesRequest {
* <p>The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon
* S3 object information.</p>
*/
CertificateArn?: string;
CertificateArn: string | undefined;

/**
* <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>
Expand Down Expand Up @@ -5280,7 +5280,7 @@ export interface GetTransitGatewayMulticastDomainAssociationsRequest {
/**
* <p>The ID of the transit gateway multicast domain.</p>
*/
TransitGatewayMulticastDomainId?: string;
TransitGatewayMulticastDomainId: string | undefined;

/**
* <p>One or more filters. The possible values are:</p>
Expand Down

0 comments on commit 3ff7382

Please sign in to comment.