Skip to content

Commit c8e1db3

Browse files
author
awstools
committed
feat(client-identitystore): New Identity Store content for China Region launch
1 parent 82dc9dc commit c8e1db3

18 files changed

+331
-328
lines changed

‎clients/client-identitystore/README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,15 @@
66

77
AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native.
88

9-
<p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
9+
<p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
1010
your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
1111
Guide</a>.</p>
12-
12+
<p>This reference guide describes the identity store operations that you can call
13+
programmatically and includes detailed information about data types and errors.</p>
1314
<note>
14-
<p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
15-
<code>identitystore</code> API namespaces will continue to retain their original name for
16-
backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
15+
<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
1716
</note>
1817

19-
<p>This reference guide describes the identity store operations that you can call
20-
programatically and includes detailed information about data types and errors.</p>
21-
2218
## Installing
2319

2420
To install the this package, simply type add or install @aws-sdk/client-identitystore

‎clients/client-identitystore/src/Identitystore.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -336,18 +336,14 @@ export interface Identitystore {
336336

337337
/**
338338
* @public
339-
* <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
339+
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
340340
* your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
341341
* Guide</a>.</p>
342-
*
342+
* <p>This reference guide describes the identity store operations that you can call
343+
* programmatically and includes detailed information about data types and errors.</p>
343344
* <note>
344-
* <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
345-
* <code>identitystore</code> API namespaces will continue to retain their original name for
346-
* backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
345+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
347346
* </note>
348-
*
349-
* <p>This reference guide describes the identity store operations that you can call
350-
* programatically and includes detailed information about data types and errors.</p>
351347
*/
352348
export class Identitystore extends IdentitystoreClient implements Identitystore {}
353349
createAggregatedClient(commands, Identitystore);

‎clients/client-identitystore/src/IdentitystoreClient.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -316,18 +316,14 @@ export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientRe
316316

317317
/**
318318
* @public
319-
* <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
319+
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
320320
* your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
321321
* Guide</a>.</p>
322-
*
322+
* <p>This reference guide describes the identity store operations that you can call
323+
* programmatically and includes detailed information about data types and errors.</p>
323324
* <note>
324-
* <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
325-
* <code>identitystore</code> API namespaces will continue to retain their original name for
326-
* backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
325+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
327326
* </note>
328-
*
329-
* <p>This reference guide describes the identity store operations that you can call
330-
* programatically and includes detailed information about data types and errors.</p>
331327
*/
332328
export class IdentitystoreClient extends __Client<
333329
__HttpHandlerOptions,

‎clients/client-identitystore/src/commands/DescribeGroupCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
4242
* @public
4343
* <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
4444
* store.</p>
45+
* <note>
46+
* <p>If you have administrator access to a member account, you can use this API from the member account.
47+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
48+
* <i>Organizations User Guide</i>. </p>
49+
* </note>
4550
* @example
4651
* Use a bare-bones client and the command you need to make an API call.
4752
* ```javascript

‎clients/client-identitystore/src/commands/DescribeGroupMembershipCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface DescribeGroupMembershipCommandOutput extends DescribeGroupMembe
3737
/**
3838
* @public
3939
* <p>Retrieves membership metadata and attributes from <code>MembershipId</code> in an identity store.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/DescribeUserCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
3737
/**
3838
* @public
3939
* <p>Retrieves the user metadata and attributes from the <code>UserId</code> in an identity store.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/GetGroupIdCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface GetGroupIdCommandOutput extends GetGroupIdResponse, __MetadataB
3737
/**
3838
* @public
3939
* <p>Retrieves <code>GroupId</code> in an identity store.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/GetGroupMembershipIdCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface GetGroupMembershipIdCommandOutput extends GetGroupMembershipIdR
3737
/**
3838
* @public
3939
* <p>Retrieves the <code>MembershipId</code> in an identity store.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/GetUserIdCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface GetUserIdCommandOutput extends GetUserIdResponse, __MetadataBea
3737
/**
3838
* @public
3939
* <p>Retrieves the <code>UserId</code> in an identity store.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/IsMemberInGroupsCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,11 @@ export interface IsMemberInGroupsCommandOutput extends IsMemberInGroupsResponse,
4141
/**
4242
* @public
4343
* <p>Checks the user's membership in all requested groups and returns if the member exists in all queried groups.</p>
44+
* <note>
45+
* <p>If you have administrator access to a member account, you can use this API from the member account.
46+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
47+
* <i>Organizations User Guide</i>. </p>
48+
* </note>
4449
* @example
4550
* Use a bare-bones client and the command you need to make an API call.
4651
* ```javascript

‎clients/client-identitystore/src/commands/ListGroupMembershipsCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ export interface ListGroupMembershipsCommandOutput extends ListGroupMembershipsR
3737
/**
3838
* @public
3939
* <p>For the specified group in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form.</p>
40+
* <note>
41+
* <p>If you have administrator access to a member account, you can use this API from the member account.
42+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
43+
* <i>Organizations User Guide</i>. </p>
44+
* </note>
4045
* @example
4146
* Use a bare-bones client and the command you need to make an API call.
4247
* ```javascript

‎clients/client-identitystore/src/commands/ListGroupMembershipsForMemberCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ export interface ListGroupMembershipsForMemberCommandOutput
4242
/**
4343
* @public
4444
* <p>For the specified member in the specified identity store, returns the list of all <code>GroupMembership</code> objects and returns results in paginated form.</p>
45+
* <note>
46+
* <p>If you have administrator access to a member account, you can use this API from the member account.
47+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
48+
* <i>Organizations User Guide</i>. </p>
49+
* </note>
4550
* @example
4651
* Use a bare-bones client and the command you need to make an API call.
4752
* ```javascript

‎clients/client-identitystore/src/commands/ListGroupsCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ export interface ListGroupsCommandOutput extends ListGroupsResponse, __MetadataB
4343
* @public
4444
* <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.
4545
* Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>
46+
* <note>
47+
* <p>If you have administrator access to a member account, you can use this API from the member account.
48+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
49+
* <i>Organizations User Guide</i>. </p>
50+
* </note>
4651
* @example
4752
* Use a bare-bones client and the command you need to make an API call.
4853
* ```javascript

‎clients/client-identitystore/src/commands/ListUsersCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,11 @@ export interface ListUsersCommandOutput extends ListUsersResponse, __MetadataBea
4343
* @public
4444
* <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.
4545
* Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>
46+
* <note>
47+
* <p>If you have administrator access to a member account, you can use this API from the member account.
48+
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
49+
* <i>Organizations User Guide</i>.</p>
50+
* </note>
4651
* @example
4752
* Use a bare-bones client and the command you need to make an API call.
4853
* ```javascript

‎clients/client-identitystore/src/endpoint/ruleset.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]},
2828
p=[j],
2929
q=[k],
3030
r=[{[v]:"Region"}];
31-
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{type:b,rules:[{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]}]},{type:b,rules:[{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://identitystore-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://identitystore.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://identitystore-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{type:b,rules:[{endpoint:{url:"https://identitystore.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{type:b,rules:[{endpoint:{url:"https://identitystore.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]}]},{error:"Invalid Configuration: Missing Region",type:c}]}]};
31+
const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]},{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{endpoint:{url:"https://identitystore-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://identitystore.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://identitystore-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{endpoint:{url:"https://identitystore.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://identitystore.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
3232
export const ruleSet: RuleSetObject = _data;

‎clients/client-identitystore/src/index.ts

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of
4+
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
55
* your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
66
* Guide</a>.</p>
7-
*
7+
* <p>This reference guide describes the identity store operations that you can call
8+
* programmatically and includes detailed information about data types and errors.</p>
89
* <note>
9-
* <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and
10-
* <code>identitystore</code> API namespaces will continue to retain their original name for
11-
* backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p>
10+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
1211
* </note>
1312
*
14-
* <p>This reference guide describes the identity store operations that you can call
15-
* programatically and includes detailed information about data types and errors.</p>
16-
*
1713
* @packageDocumentation
1814
*/
1915
export * from "./IdentitystoreClient";

‎clients/client-identitystore/src/models/models_0.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ export interface UniqueAttribute {
126126
/**
127127
* @public
128128
* <p>The value of the attribute. This is a <code>Document</code> type.
129-
* This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
129+
* This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
130130
*/
131131
AttributeValue: __DocumentType | undefined;
132132
}
@@ -202,7 +202,7 @@ export interface AttributeOperation {
202202
/**
203203
* @public
204204
* <p>The value of the attribute. This is a <code>Document</code> type.
205-
* This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
205+
* This type is not supported by Java V1, Go V1, and older versions of the CLI.</p>
206206
*/
207207
AttributeValue?: __DocumentType;
208208
}
@@ -816,8 +816,8 @@ export interface CreateGroupRequest {
816816
/**
817817
* @public
818818
* <p>A string containing the name of the group. This value is commonly displayed when the
819-
* group is referenced. "Administrator" and "AWSAdministrators" are reserved names and can't be used for users
820-
* or groups.</p>
819+
* group is referenced. <code>Administrator</code> and <code>AWSAdministrators</code> are
820+
* reserved names and can't be used for users or groups.</p>
821821
*/
822822
DisplayName?: string;
823823

@@ -1300,8 +1300,8 @@ export interface CreateUserRequest {
13001300
* <p>A unique string used to identify the user. The length limit is 128 characters. This
13011301
* value can consist of letters, accented characters, symbols, numbers, and punctuation. This
13021302
* value is specified at the time the user is created and stored as an attribute of the user
1303-
* object in the identity store. "Administrator" and "AWSAdministrators" are reserved names and can't be used for users
1304-
* or groups.</p>
1303+
* object in the identity store. <code>Administrator</code> and <code>AWSAdministrators</code>
1304+
* are reserved names and can't be used for users or groups.</p>
13051305
*/
13061306
UserName?: string;
13071307

0 commit comments

Comments
 (0)