aws-sdk-identitystore 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/aws-sdk-identitystore.rb +52 -0
- data/lib/aws-sdk-identitystore/client.rb +569 -0
- data/lib/aws-sdk-identitystore/client_api.rb +209 -0
- data/lib/aws-sdk-identitystore/customizations.rb +0 -0
- data/lib/aws-sdk-identitystore/errors.rb +153 -0
- data/lib/aws-sdk-identitystore/resource.rb +26 -0
- data/lib/aws-sdk-identitystore/types.rb +472 -0
- metadata +88 -0
@@ -0,0 +1,209 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IdentityStore
|
11
|
+
# @api private
|
12
|
+
module ClientApi
|
13
|
+
|
14
|
+
include Seahorse::Model
|
15
|
+
|
16
|
+
AccessDeniedException = Shapes::StructureShape.new(name: 'AccessDeniedException')
|
17
|
+
AttributePath = Shapes::StringShape.new(name: 'AttributePath')
|
18
|
+
DescribeGroupRequest = Shapes::StructureShape.new(name: 'DescribeGroupRequest')
|
19
|
+
DescribeGroupResponse = Shapes::StructureShape.new(name: 'DescribeGroupResponse')
|
20
|
+
DescribeUserRequest = Shapes::StructureShape.new(name: 'DescribeUserRequest')
|
21
|
+
DescribeUserResponse = Shapes::StructureShape.new(name: 'DescribeUserResponse')
|
22
|
+
Filter = Shapes::StructureShape.new(name: 'Filter')
|
23
|
+
Filters = Shapes::ListShape.new(name: 'Filters')
|
24
|
+
Group = Shapes::StructureShape.new(name: 'Group')
|
25
|
+
GroupDisplayName = Shapes::StringShape.new(name: 'GroupDisplayName')
|
26
|
+
Groups = Shapes::ListShape.new(name: 'Groups')
|
27
|
+
IdentityStoreId = Shapes::StringShape.new(name: 'IdentityStoreId')
|
28
|
+
InternalServerException = Shapes::StructureShape.new(name: 'InternalServerException')
|
29
|
+
ListGroupsRequest = Shapes::StructureShape.new(name: 'ListGroupsRequest')
|
30
|
+
ListGroupsResponse = Shapes::StructureShape.new(name: 'ListGroupsResponse')
|
31
|
+
ListUsersRequest = Shapes::StructureShape.new(name: 'ListUsersRequest')
|
32
|
+
ListUsersResponse = Shapes::StructureShape.new(name: 'ListUsersResponse')
|
33
|
+
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
34
|
+
Message = Shapes::StringShape.new(name: 'Message')
|
35
|
+
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
36
|
+
RequestId = Shapes::StringShape.new(name: 'RequestId')
|
37
|
+
ResourceId = Shapes::StringShape.new(name: 'ResourceId')
|
38
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
39
|
+
ResourceType = Shapes::StringShape.new(name: 'ResourceType')
|
40
|
+
SensitiveStringType = Shapes::StringShape.new(name: 'SensitiveStringType')
|
41
|
+
ThrottlingException = Shapes::StructureShape.new(name: 'ThrottlingException')
|
42
|
+
User = Shapes::StructureShape.new(name: 'User')
|
43
|
+
UserName = Shapes::StringShape.new(name: 'UserName')
|
44
|
+
Users = Shapes::ListShape.new(name: 'Users')
|
45
|
+
ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
|
46
|
+
|
47
|
+
AccessDeniedException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
48
|
+
AccessDeniedException.add_member(:request_id, Shapes::ShapeRef.new(shape: RequestId, location_name: "RequestId"))
|
49
|
+
AccessDeniedException.struct_class = Types::AccessDeniedException
|
50
|
+
|
51
|
+
DescribeGroupRequest.add_member(:identity_store_id, Shapes::ShapeRef.new(shape: IdentityStoreId, required: true, location_name: "IdentityStoreId"))
|
52
|
+
DescribeGroupRequest.add_member(:group_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "GroupId"))
|
53
|
+
DescribeGroupRequest.struct_class = Types::DescribeGroupRequest
|
54
|
+
|
55
|
+
DescribeGroupResponse.add_member(:group_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "GroupId"))
|
56
|
+
DescribeGroupResponse.add_member(:display_name, Shapes::ShapeRef.new(shape: GroupDisplayName, required: true, location_name: "DisplayName"))
|
57
|
+
DescribeGroupResponse.struct_class = Types::DescribeGroupResponse
|
58
|
+
|
59
|
+
DescribeUserRequest.add_member(:identity_store_id, Shapes::ShapeRef.new(shape: IdentityStoreId, required: true, location_name: "IdentityStoreId"))
|
60
|
+
DescribeUserRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "UserId"))
|
61
|
+
DescribeUserRequest.struct_class = Types::DescribeUserRequest
|
62
|
+
|
63
|
+
DescribeUserResponse.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, required: true, location_name: "UserName"))
|
64
|
+
DescribeUserResponse.add_member(:user_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "UserId"))
|
65
|
+
DescribeUserResponse.struct_class = Types::DescribeUserResponse
|
66
|
+
|
67
|
+
Filter.add_member(:attribute_path, Shapes::ShapeRef.new(shape: AttributePath, required: true, location_name: "AttributePath"))
|
68
|
+
Filter.add_member(:attribute_value, Shapes::ShapeRef.new(shape: SensitiveStringType, required: true, location_name: "AttributeValue"))
|
69
|
+
Filter.struct_class = Types::Filter
|
70
|
+
|
71
|
+
Filters.member = Shapes::ShapeRef.new(shape: Filter)
|
72
|
+
|
73
|
+
Group.add_member(:group_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "GroupId"))
|
74
|
+
Group.add_member(:display_name, Shapes::ShapeRef.new(shape: GroupDisplayName, required: true, location_name: "DisplayName"))
|
75
|
+
Group.struct_class = Types::Group
|
76
|
+
|
77
|
+
Groups.member = Shapes::ShapeRef.new(shape: Group)
|
78
|
+
|
79
|
+
InternalServerException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
80
|
+
InternalServerException.add_member(:request_id, Shapes::ShapeRef.new(shape: RequestId, location_name: "RequestId"))
|
81
|
+
InternalServerException.struct_class = Types::InternalServerException
|
82
|
+
|
83
|
+
ListGroupsRequest.add_member(:identity_store_id, Shapes::ShapeRef.new(shape: IdentityStoreId, required: true, location_name: "IdentityStoreId"))
|
84
|
+
ListGroupsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
85
|
+
ListGroupsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
86
|
+
ListGroupsRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
87
|
+
ListGroupsRequest.struct_class = Types::ListGroupsRequest
|
88
|
+
|
89
|
+
ListGroupsResponse.add_member(:groups, Shapes::ShapeRef.new(shape: Groups, required: true, location_name: "Groups"))
|
90
|
+
ListGroupsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
91
|
+
ListGroupsResponse.struct_class = Types::ListGroupsResponse
|
92
|
+
|
93
|
+
ListUsersRequest.add_member(:identity_store_id, Shapes::ShapeRef.new(shape: IdentityStoreId, required: true, location_name: "IdentityStoreId"))
|
94
|
+
ListUsersRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
95
|
+
ListUsersRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
96
|
+
ListUsersRequest.add_member(:filters, Shapes::ShapeRef.new(shape: Filters, location_name: "Filters"))
|
97
|
+
ListUsersRequest.struct_class = Types::ListUsersRequest
|
98
|
+
|
99
|
+
ListUsersResponse.add_member(:users, Shapes::ShapeRef.new(shape: Users, required: true, location_name: "Users"))
|
100
|
+
ListUsersResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
101
|
+
ListUsersResponse.struct_class = Types::ListUsersResponse
|
102
|
+
|
103
|
+
ResourceNotFoundException.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
104
|
+
ResourceNotFoundException.add_member(:resource_id, Shapes::ShapeRef.new(shape: ResourceId, location_name: "ResourceId"))
|
105
|
+
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
106
|
+
ResourceNotFoundException.add_member(:request_id, Shapes::ShapeRef.new(shape: RequestId, location_name: "RequestId"))
|
107
|
+
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
108
|
+
|
109
|
+
ThrottlingException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
110
|
+
ThrottlingException.add_member(:request_id, Shapes::ShapeRef.new(shape: RequestId, location_name: "RequestId"))
|
111
|
+
ThrottlingException.struct_class = Types::ThrottlingException
|
112
|
+
|
113
|
+
User.add_member(:user_name, Shapes::ShapeRef.new(shape: UserName, required: true, location_name: "UserName"))
|
114
|
+
User.add_member(:user_id, Shapes::ShapeRef.new(shape: ResourceId, required: true, location_name: "UserId"))
|
115
|
+
User.struct_class = Types::User
|
116
|
+
|
117
|
+
Users.member = Shapes::ShapeRef.new(shape: User)
|
118
|
+
|
119
|
+
ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: Message, location_name: "Message"))
|
120
|
+
ValidationException.add_member(:request_id, Shapes::ShapeRef.new(shape: RequestId, location_name: "RequestId"))
|
121
|
+
ValidationException.struct_class = Types::ValidationException
|
122
|
+
|
123
|
+
|
124
|
+
# @api private
|
125
|
+
API = Seahorse::Model::Api.new.tap do |api|
|
126
|
+
|
127
|
+
api.version = "2020-06-15"
|
128
|
+
|
129
|
+
api.metadata = {
|
130
|
+
"apiVersion" => "2020-06-15",
|
131
|
+
"endpointPrefix" => "identitystore",
|
132
|
+
"jsonVersion" => "1.1",
|
133
|
+
"protocol" => "json",
|
134
|
+
"serviceAbbreviation" => "IdentityStore",
|
135
|
+
"serviceFullName" => "AWS SSO Identity Store",
|
136
|
+
"serviceId" => "identitystore",
|
137
|
+
"signatureVersion" => "v4",
|
138
|
+
"signingName" => "identitystore",
|
139
|
+
"targetPrefix" => "AWSIdentityStore",
|
140
|
+
"uid" => "identitystore-2020-06-15",
|
141
|
+
}
|
142
|
+
|
143
|
+
api.add_operation(:describe_group, Seahorse::Model::Operation.new.tap do |o|
|
144
|
+
o.name = "DescribeGroup"
|
145
|
+
o.http_method = "POST"
|
146
|
+
o.http_request_uri = "/"
|
147
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeGroupRequest)
|
148
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeGroupResponse)
|
149
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
150
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
151
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
152
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
153
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
154
|
+
end)
|
155
|
+
|
156
|
+
api.add_operation(:describe_user, Seahorse::Model::Operation.new.tap do |o|
|
157
|
+
o.name = "DescribeUser"
|
158
|
+
o.http_method = "POST"
|
159
|
+
o.http_request_uri = "/"
|
160
|
+
o.input = Shapes::ShapeRef.new(shape: DescribeUserRequest)
|
161
|
+
o.output = Shapes::ShapeRef.new(shape: DescribeUserResponse)
|
162
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
163
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
164
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
165
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
166
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
167
|
+
end)
|
168
|
+
|
169
|
+
api.add_operation(:list_groups, Seahorse::Model::Operation.new.tap do |o|
|
170
|
+
o.name = "ListGroups"
|
171
|
+
o.http_method = "POST"
|
172
|
+
o.http_request_uri = "/"
|
173
|
+
o.input = Shapes::ShapeRef.new(shape: ListGroupsRequest)
|
174
|
+
o.output = Shapes::ShapeRef.new(shape: ListGroupsResponse)
|
175
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
176
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
177
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
178
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
179
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
180
|
+
o[:pager] = Aws::Pager.new(
|
181
|
+
limit_key: "max_results",
|
182
|
+
tokens: {
|
183
|
+
"next_token" => "next_token"
|
184
|
+
}
|
185
|
+
)
|
186
|
+
end)
|
187
|
+
|
188
|
+
api.add_operation(:list_users, Seahorse::Model::Operation.new.tap do |o|
|
189
|
+
o.name = "ListUsers"
|
190
|
+
o.http_method = "POST"
|
191
|
+
o.http_request_uri = "/"
|
192
|
+
o.input = Shapes::ShapeRef.new(shape: ListUsersRequest)
|
193
|
+
o.output = Shapes::ShapeRef.new(shape: ListUsersResponse)
|
194
|
+
o.errors << Shapes::ShapeRef.new(shape: ValidationException)
|
195
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
196
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
197
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
|
198
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
|
199
|
+
o[:pager] = Aws::Pager.new(
|
200
|
+
limit_key: "max_results",
|
201
|
+
tokens: {
|
202
|
+
"next_token" => "next_token"
|
203
|
+
}
|
204
|
+
)
|
205
|
+
end)
|
206
|
+
end
|
207
|
+
|
208
|
+
end
|
209
|
+
end
|
File without changes
|
@@ -0,0 +1,153 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IdentityStore
|
11
|
+
|
12
|
+
# When IdentityStore returns an error response, the Ruby SDK constructs and raises an error.
|
13
|
+
# These errors all extend Aws::IdentityStore::Errors::ServiceError < {Aws::Errors::ServiceError}
|
14
|
+
#
|
15
|
+
# You can rescue all IdentityStore errors using ServiceError:
|
16
|
+
#
|
17
|
+
# begin
|
18
|
+
# # do stuff
|
19
|
+
# rescue Aws::IdentityStore::Errors::ServiceError
|
20
|
+
# # rescues all IdentityStore API errors
|
21
|
+
# end
|
22
|
+
#
|
23
|
+
#
|
24
|
+
# ## Request Context
|
25
|
+
# ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
|
26
|
+
# information about the request that generated the error.
|
27
|
+
# See {Seahorse::Client::RequestContext} for more information.
|
28
|
+
#
|
29
|
+
# ## Error Classes
|
30
|
+
# * {AccessDeniedException}
|
31
|
+
# * {InternalServerException}
|
32
|
+
# * {ResourceNotFoundException}
|
33
|
+
# * {ThrottlingException}
|
34
|
+
# * {ValidationException}
|
35
|
+
#
|
36
|
+
# Additionally, error classes are dynamically generated for service errors based on the error code
|
37
|
+
# if they are not defined above.
|
38
|
+
module Errors
|
39
|
+
|
40
|
+
extend Aws::Errors::DynamicErrors
|
41
|
+
|
42
|
+
class AccessDeniedException < ServiceError
|
43
|
+
|
44
|
+
# @param [Seahorse::Client::RequestContext] context
|
45
|
+
# @param [String] message
|
46
|
+
# @param [Aws::IdentityStore::Types::AccessDeniedException] data
|
47
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
48
|
+
super(context, message, data)
|
49
|
+
end
|
50
|
+
|
51
|
+
# @return [String]
|
52
|
+
def message
|
53
|
+
@message || @data[:message]
|
54
|
+
end
|
55
|
+
|
56
|
+
# @return [String]
|
57
|
+
def request_id
|
58
|
+
@data[:request_id]
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
class InternalServerException < ServiceError
|
63
|
+
|
64
|
+
# @param [Seahorse::Client::RequestContext] context
|
65
|
+
# @param [String] message
|
66
|
+
# @param [Aws::IdentityStore::Types::InternalServerException] data
|
67
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
68
|
+
super(context, message, data)
|
69
|
+
end
|
70
|
+
|
71
|
+
# @return [String]
|
72
|
+
def message
|
73
|
+
@message || @data[:message]
|
74
|
+
end
|
75
|
+
|
76
|
+
# @return [String]
|
77
|
+
def request_id
|
78
|
+
@data[:request_id]
|
79
|
+
end
|
80
|
+
end
|
81
|
+
|
82
|
+
class ResourceNotFoundException < ServiceError
|
83
|
+
|
84
|
+
# @param [Seahorse::Client::RequestContext] context
|
85
|
+
# @param [String] message
|
86
|
+
# @param [Aws::IdentityStore::Types::ResourceNotFoundException] data
|
87
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
88
|
+
super(context, message, data)
|
89
|
+
end
|
90
|
+
|
91
|
+
# @return [String]
|
92
|
+
def resource_type
|
93
|
+
@data[:resource_type]
|
94
|
+
end
|
95
|
+
|
96
|
+
# @return [String]
|
97
|
+
def resource_id
|
98
|
+
@data[:resource_id]
|
99
|
+
end
|
100
|
+
|
101
|
+
# @return [String]
|
102
|
+
def message
|
103
|
+
@message || @data[:message]
|
104
|
+
end
|
105
|
+
|
106
|
+
# @return [String]
|
107
|
+
def request_id
|
108
|
+
@data[:request_id]
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
class ThrottlingException < ServiceError
|
113
|
+
|
114
|
+
# @param [Seahorse::Client::RequestContext] context
|
115
|
+
# @param [String] message
|
116
|
+
# @param [Aws::IdentityStore::Types::ThrottlingException] data
|
117
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
118
|
+
super(context, message, data)
|
119
|
+
end
|
120
|
+
|
121
|
+
# @return [String]
|
122
|
+
def message
|
123
|
+
@message || @data[:message]
|
124
|
+
end
|
125
|
+
|
126
|
+
# @return [String]
|
127
|
+
def request_id
|
128
|
+
@data[:request_id]
|
129
|
+
end
|
130
|
+
end
|
131
|
+
|
132
|
+
class ValidationException < ServiceError
|
133
|
+
|
134
|
+
# @param [Seahorse::Client::RequestContext] context
|
135
|
+
# @param [String] message
|
136
|
+
# @param [Aws::IdentityStore::Types::ValidationException] data
|
137
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
138
|
+
super(context, message, data)
|
139
|
+
end
|
140
|
+
|
141
|
+
# @return [String]
|
142
|
+
def message
|
143
|
+
@message || @data[:message]
|
144
|
+
end
|
145
|
+
|
146
|
+
# @return [String]
|
147
|
+
def request_id
|
148
|
+
@data[:request_id]
|
149
|
+
end
|
150
|
+
end
|
151
|
+
|
152
|
+
end
|
153
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IdentityStore
|
11
|
+
|
12
|
+
class Resource
|
13
|
+
|
14
|
+
# @param options ({})
|
15
|
+
# @option options [Client] :client
|
16
|
+
def initialize(options = {})
|
17
|
+
@client = options[:client] || Client.new(options)
|
18
|
+
end
|
19
|
+
|
20
|
+
# @return [Client]
|
21
|
+
def client
|
22
|
+
@client
|
23
|
+
end
|
24
|
+
|
25
|
+
end
|
26
|
+
end
|
@@ -0,0 +1,472 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# WARNING ABOUT GENERATED CODE
|
4
|
+
#
|
5
|
+
# This file is generated. See the contributing guide for more information:
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
7
|
+
#
|
8
|
+
# WARNING ABOUT GENERATED CODE
|
9
|
+
|
10
|
+
module Aws::IdentityStore
|
11
|
+
module Types
|
12
|
+
|
13
|
+
# You do not have sufficient access to perform this action.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @!attribute [rw] request_id
|
19
|
+
# The identifier for each request. This value is a globally unique ID
|
20
|
+
# that is generated by the Identity Store service for each sent
|
21
|
+
# request, and is then returned inside the exception if the request
|
22
|
+
# fails.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/AccessDeniedException AWS API Documentation
|
26
|
+
#
|
27
|
+
class AccessDeniedException < Struct.new(
|
28
|
+
:message,
|
29
|
+
:request_id)
|
30
|
+
SENSITIVE = []
|
31
|
+
include Aws::Structure
|
32
|
+
end
|
33
|
+
|
34
|
+
# @note When making an API call, you may pass DescribeGroupRequest
|
35
|
+
# data as a hash:
|
36
|
+
#
|
37
|
+
# {
|
38
|
+
# identity_store_id: "IdentityStoreId", # required
|
39
|
+
# group_id: "ResourceId", # required
|
40
|
+
# }
|
41
|
+
#
|
42
|
+
# @!attribute [rw] identity_store_id
|
43
|
+
# The globally unique identifier for the identity store, such as
|
44
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890
|
45
|
+
# is a randomly generated string which contains number and lower case
|
46
|
+
# letters. This value is generated at the time that a new identity
|
47
|
+
# store is created.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] group_id
|
51
|
+
# The identifier for a group in the identity store.
|
52
|
+
# @return [String]
|
53
|
+
#
|
54
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupRequest AWS API Documentation
|
55
|
+
#
|
56
|
+
class DescribeGroupRequest < Struct.new(
|
57
|
+
:identity_store_id,
|
58
|
+
:group_id)
|
59
|
+
SENSITIVE = []
|
60
|
+
include Aws::Structure
|
61
|
+
end
|
62
|
+
|
63
|
+
# @!attribute [rw] group_id
|
64
|
+
# The identifier for a group in the identity store.
|
65
|
+
# @return [String]
|
66
|
+
#
|
67
|
+
# @!attribute [rw] display_name
|
68
|
+
# Contains the group’s display name value. The length limit is 1024
|
69
|
+
# characters. This value can consist of letters, accented characters,
|
70
|
+
# symbols, numbers, punctuation, tab, new line, carriage return, space
|
71
|
+
# and non breaking space in this attribute. The characters
|
72
|
+
# “<>;:%” are excluded. This value is specified at the time the
|
73
|
+
# group is created and stored as an attribute of the group object in
|
74
|
+
# the identity store.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeGroupResponse AWS API Documentation
|
78
|
+
#
|
79
|
+
class DescribeGroupResponse < Struct.new(
|
80
|
+
:group_id,
|
81
|
+
:display_name)
|
82
|
+
SENSITIVE = []
|
83
|
+
include Aws::Structure
|
84
|
+
end
|
85
|
+
|
86
|
+
# @note When making an API call, you may pass DescribeUserRequest
|
87
|
+
# data as a hash:
|
88
|
+
#
|
89
|
+
# {
|
90
|
+
# identity_store_id: "IdentityStoreId", # required
|
91
|
+
# user_id: "ResourceId", # required
|
92
|
+
# }
|
93
|
+
#
|
94
|
+
# @!attribute [rw] identity_store_id
|
95
|
+
# The globally unique identifier for the identity store, such as
|
96
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890
|
97
|
+
# is a randomly generated string which contains number and lower case
|
98
|
+
# letters. This value is generated at the time that a new identity
|
99
|
+
# store is created.
|
100
|
+
# @return [String]
|
101
|
+
#
|
102
|
+
# @!attribute [rw] user_id
|
103
|
+
# The identifier for a user in the identity store.
|
104
|
+
# @return [String]
|
105
|
+
#
|
106
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserRequest AWS API Documentation
|
107
|
+
#
|
108
|
+
class DescribeUserRequest < Struct.new(
|
109
|
+
:identity_store_id,
|
110
|
+
:user_id)
|
111
|
+
SENSITIVE = []
|
112
|
+
include Aws::Structure
|
113
|
+
end
|
114
|
+
|
115
|
+
# @!attribute [rw] user_name
|
116
|
+
# Contains the user’s username value. The length limit is 128
|
117
|
+
# characters. This value can consist of letters, accented characters,
|
118
|
+
# symbols, numbers and punctuation. The characters “<>;:%” are
|
119
|
+
# excluded. This value is specified at the time the user is created
|
120
|
+
# and stored as an attribute of the user object in the identity store.
|
121
|
+
# @return [String]
|
122
|
+
#
|
123
|
+
# @!attribute [rw] user_id
|
124
|
+
# The identifier for a user in the identity store.
|
125
|
+
# @return [String]
|
126
|
+
#
|
127
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/DescribeUserResponse AWS API Documentation
|
128
|
+
#
|
129
|
+
class DescribeUserResponse < Struct.new(
|
130
|
+
:user_name,
|
131
|
+
:user_id)
|
132
|
+
SENSITIVE = [:user_name]
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
136
|
+
# A query filter used by `ListUsers` and `ListGroup`. This filter object
|
137
|
+
# provides the attribute name and attribute value to search users or
|
138
|
+
# groups.
|
139
|
+
#
|
140
|
+
# @note When making an API call, you may pass Filter
|
141
|
+
# data as a hash:
|
142
|
+
#
|
143
|
+
# {
|
144
|
+
# attribute_path: "AttributePath", # required
|
145
|
+
# attribute_value: "SensitiveStringType", # required
|
146
|
+
# }
|
147
|
+
#
|
148
|
+
# @!attribute [rw] attribute_path
|
149
|
+
# The attribute path used to specify which attribute name to search.
|
150
|
+
# Length limit is 255 characters. For example, `UserName` is a valid
|
151
|
+
# attribute path for the `ListUsers` API, and `DisplayName` is a valid
|
152
|
+
# attribute path for the `ListGroups` API.
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] attribute_value
|
156
|
+
# Represents the data for an attribute. Each attribute value is
|
157
|
+
# described as a name-value pair.
|
158
|
+
# @return [String]
|
159
|
+
#
|
160
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Filter AWS API Documentation
|
161
|
+
#
|
162
|
+
class Filter < Struct.new(
|
163
|
+
:attribute_path,
|
164
|
+
:attribute_value)
|
165
|
+
SENSITIVE = [:attribute_value]
|
166
|
+
include Aws::Structure
|
167
|
+
end
|
168
|
+
|
169
|
+
# A group object, which contains a specified group’s metadata and
|
170
|
+
# attributes.
|
171
|
+
#
|
172
|
+
# @!attribute [rw] group_id
|
173
|
+
# The identifier for a group in the identity store.
|
174
|
+
# @return [String]
|
175
|
+
#
|
176
|
+
# @!attribute [rw] display_name
|
177
|
+
# Contains the group’s display name value. The length limit is 1024
|
178
|
+
# characters. This value can consist of letters, accented characters,
|
179
|
+
# symbols, numbers, punctuation, tab, new line, carriage return, space
|
180
|
+
# and non breaking space in this attribute. The characters
|
181
|
+
# “<>;:%” are excluded. This value is specified at the time the
|
182
|
+
# group is created and stored as an attribute of the group object in
|
183
|
+
# the identity store.
|
184
|
+
# @return [String]
|
185
|
+
#
|
186
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/Group AWS API Documentation
|
187
|
+
#
|
188
|
+
class Group < Struct.new(
|
189
|
+
:group_id,
|
190
|
+
:display_name)
|
191
|
+
SENSITIVE = []
|
192
|
+
include Aws::Structure
|
193
|
+
end
|
194
|
+
|
195
|
+
# The request processing has failed because of an unknown error,
|
196
|
+
# exception or failure with an internal server.
|
197
|
+
#
|
198
|
+
# @!attribute [rw] message
|
199
|
+
# @return [String]
|
200
|
+
#
|
201
|
+
# @!attribute [rw] request_id
|
202
|
+
# The identifier for each request. This value is a globally unique ID
|
203
|
+
# that is generated by the Identity Store service for each sent
|
204
|
+
# request, and is then returned inside the exception if the request
|
205
|
+
# fails.
|
206
|
+
# @return [String]
|
207
|
+
#
|
208
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/InternalServerException AWS API Documentation
|
209
|
+
#
|
210
|
+
class InternalServerException < Struct.new(
|
211
|
+
:message,
|
212
|
+
:request_id)
|
213
|
+
SENSITIVE = []
|
214
|
+
include Aws::Structure
|
215
|
+
end
|
216
|
+
|
217
|
+
# @note When making an API call, you may pass ListGroupsRequest
|
218
|
+
# data as a hash:
|
219
|
+
#
|
220
|
+
# {
|
221
|
+
# identity_store_id: "IdentityStoreId", # required
|
222
|
+
# max_results: 1,
|
223
|
+
# next_token: "NextToken",
|
224
|
+
# filters: [
|
225
|
+
# {
|
226
|
+
# attribute_path: "AttributePath", # required
|
227
|
+
# attribute_value: "SensitiveStringType", # required
|
228
|
+
# },
|
229
|
+
# ],
|
230
|
+
# }
|
231
|
+
#
|
232
|
+
# @!attribute [rw] identity_store_id
|
233
|
+
# The globally unique identifier for the identity store, such as
|
234
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890
|
235
|
+
# is a randomly generated string which contains number and lower case
|
236
|
+
# letters. This value is generated at the time that a new identity
|
237
|
+
# store is created.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] max_results
|
241
|
+
# The maximum number of results to be returned per request, which is
|
242
|
+
# used in the `ListUsers` and `ListGroups` request to specify how many
|
243
|
+
# results to return in one page. The length limit is 50 characters.
|
244
|
+
# @return [Integer]
|
245
|
+
#
|
246
|
+
# @!attribute [rw] next_token
|
247
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
248
|
+
# This value is generated by the identity store service and is
|
249
|
+
# returned in the API response if the total results are more than the
|
250
|
+
# size of one page, and when this token is used in the API request to
|
251
|
+
# search for the next page.
|
252
|
+
# @return [String]
|
253
|
+
#
|
254
|
+
# @!attribute [rw] filters
|
255
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and
|
256
|
+
# `ListGroups` request.
|
257
|
+
# @return [Array<Types::Filter>]
|
258
|
+
#
|
259
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupsRequest AWS API Documentation
|
260
|
+
#
|
261
|
+
class ListGroupsRequest < Struct.new(
|
262
|
+
:identity_store_id,
|
263
|
+
:max_results,
|
264
|
+
:next_token,
|
265
|
+
:filters)
|
266
|
+
SENSITIVE = []
|
267
|
+
include Aws::Structure
|
268
|
+
end
|
269
|
+
|
270
|
+
# @!attribute [rw] groups
|
271
|
+
# A list of `Group` objects in the identity store.
|
272
|
+
# @return [Array<Types::Group>]
|
273
|
+
#
|
274
|
+
# @!attribute [rw] next_token
|
275
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
276
|
+
# This value is generated by the identity store service and is
|
277
|
+
# returned in the API response if the total results are more than the
|
278
|
+
# size of one page, and when this token is used in the API request to
|
279
|
+
# search for the next page.
|
280
|
+
# @return [String]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListGroupsResponse AWS API Documentation
|
283
|
+
#
|
284
|
+
class ListGroupsResponse < Struct.new(
|
285
|
+
:groups,
|
286
|
+
:next_token)
|
287
|
+
SENSITIVE = []
|
288
|
+
include Aws::Structure
|
289
|
+
end
|
290
|
+
|
291
|
+
# @note When making an API call, you may pass ListUsersRequest
|
292
|
+
# data as a hash:
|
293
|
+
#
|
294
|
+
# {
|
295
|
+
# identity_store_id: "IdentityStoreId", # required
|
296
|
+
# max_results: 1,
|
297
|
+
# next_token: "NextToken",
|
298
|
+
# filters: [
|
299
|
+
# {
|
300
|
+
# attribute_path: "AttributePath", # required
|
301
|
+
# attribute_value: "SensitiveStringType", # required
|
302
|
+
# },
|
303
|
+
# ],
|
304
|
+
# }
|
305
|
+
#
|
306
|
+
# @!attribute [rw] identity_store_id
|
307
|
+
# The globally unique identifier for the identity store, such as
|
308
|
+
# d-1234567890. In this example, d- is a fixed prefix, and 1234567890
|
309
|
+
# is a randomly generated string which contains number and lower case
|
310
|
+
# letters. This value is generated at the time that a new identity
|
311
|
+
# store is created.
|
312
|
+
# @return [String]
|
313
|
+
#
|
314
|
+
# @!attribute [rw] max_results
|
315
|
+
# The maximum number of results to be returned per request, which is
|
316
|
+
# used in the `ListUsers` and `ListGroups` request to specify how many
|
317
|
+
# results to return in one page. The length limit is 50 characters.
|
318
|
+
# @return [Integer]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] next_token
|
321
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
322
|
+
# This value is generated by the identity store service and is
|
323
|
+
# returned in the API response if the total results are more than the
|
324
|
+
# size of one page, and when this token is used in the API request to
|
325
|
+
# search for the next page.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] filters
|
329
|
+
# A list of `Filter` objects, which is used in the `ListUsers` and
|
330
|
+
# `ListGroups` request.
|
331
|
+
# @return [Array<Types::Filter>]
|
332
|
+
#
|
333
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsersRequest AWS API Documentation
|
334
|
+
#
|
335
|
+
class ListUsersRequest < Struct.new(
|
336
|
+
:identity_store_id,
|
337
|
+
:max_results,
|
338
|
+
:next_token,
|
339
|
+
:filters)
|
340
|
+
SENSITIVE = []
|
341
|
+
include Aws::Structure
|
342
|
+
end
|
343
|
+
|
344
|
+
# @!attribute [rw] users
|
345
|
+
# A list of `User` objects in the identity store.
|
346
|
+
# @return [Array<Types::User>]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] next_token
|
349
|
+
# The pagination token used for the `ListUsers` and `ListGroups` APIs.
|
350
|
+
# This value is generated by the identity store service and is
|
351
|
+
# returned in the API response if the total results are more than the
|
352
|
+
# size of one page, and when this token is used in the API request to
|
353
|
+
# search for the next page.
|
354
|
+
# @return [String]
|
355
|
+
#
|
356
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ListUsersResponse AWS API Documentation
|
357
|
+
#
|
358
|
+
class ListUsersResponse < Struct.new(
|
359
|
+
:users,
|
360
|
+
:next_token)
|
361
|
+
SENSITIVE = []
|
362
|
+
include Aws::Structure
|
363
|
+
end
|
364
|
+
|
365
|
+
# Indicates that a requested resource is not found.
|
366
|
+
#
|
367
|
+
# @!attribute [rw] resource_type
|
368
|
+
# The type of resource in the Identity Store service, which is an enum
|
369
|
+
# object. Valid values include USER, GROUP, and IDENTITY\_STORE.
|
370
|
+
# @return [String]
|
371
|
+
#
|
372
|
+
# @!attribute [rw] resource_id
|
373
|
+
# The identifier for a resource in the identity store, which can be
|
374
|
+
# used as `UserId` or `GroupId`. The format for `ResourceId` is either
|
375
|
+
# `UUID` or `1234567890-UUID`, where `UUID` is a randomly generated
|
376
|
+
# value for each resource when it is created and `1234567890`
|
377
|
+
# represents the `IdentityStoreId` string value. In the case that the
|
378
|
+
# identity store is migrated from a legacy SSO identity store, the
|
379
|
+
# `ResourceId` for that identity store will be in the format of
|
380
|
+
# `UUID`. Otherwise, it will be in the `1234567890-UUID` format.
|
381
|
+
# @return [String]
|
382
|
+
#
|
383
|
+
# @!attribute [rw] message
|
384
|
+
# @return [String]
|
385
|
+
#
|
386
|
+
# @!attribute [rw] request_id
|
387
|
+
# The identifier for each request. This value is a globally unique ID
|
388
|
+
# that is generated by the Identity Store service for each sent
|
389
|
+
# request, and is then returned inside the exception if the request
|
390
|
+
# fails.
|
391
|
+
# @return [String]
|
392
|
+
#
|
393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ResourceNotFoundException AWS API Documentation
|
394
|
+
#
|
395
|
+
class ResourceNotFoundException < Struct.new(
|
396
|
+
:resource_type,
|
397
|
+
:resource_id,
|
398
|
+
:message,
|
399
|
+
:request_id)
|
400
|
+
SENSITIVE = []
|
401
|
+
include Aws::Structure
|
402
|
+
end
|
403
|
+
|
404
|
+
# Indicates that the principal has crossed the throttling limits of the
|
405
|
+
# API operations.
|
406
|
+
#
|
407
|
+
# @!attribute [rw] message
|
408
|
+
# @return [String]
|
409
|
+
#
|
410
|
+
# @!attribute [rw] request_id
|
411
|
+
# The identifier for each request. This value is a globally unique ID
|
412
|
+
# that is generated by the Identity Store service for each sent
|
413
|
+
# request, and is then returned inside the exception if the request
|
414
|
+
# fails.
|
415
|
+
# @return [String]
|
416
|
+
#
|
417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ThrottlingException AWS API Documentation
|
418
|
+
#
|
419
|
+
class ThrottlingException < Struct.new(
|
420
|
+
:message,
|
421
|
+
:request_id)
|
422
|
+
SENSITIVE = []
|
423
|
+
include Aws::Structure
|
424
|
+
end
|
425
|
+
|
426
|
+
# A user object, which contains a specified user’s metadata and
|
427
|
+
# attributes.
|
428
|
+
#
|
429
|
+
# @!attribute [rw] user_name
|
430
|
+
# Contains the user’s username value. The length limit is 128
|
431
|
+
# characters. This value can consist of letters, accented characters,
|
432
|
+
# symbols, numbers and punctuation. The characters “<>;:%” are
|
433
|
+
# excluded. This value is specified at the time the user is created
|
434
|
+
# and stored as an attribute of the user object in the identity store.
|
435
|
+
# @return [String]
|
436
|
+
#
|
437
|
+
# @!attribute [rw] user_id
|
438
|
+
# The identifier for a user in the identity store.
|
439
|
+
# @return [String]
|
440
|
+
#
|
441
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/User AWS API Documentation
|
442
|
+
#
|
443
|
+
class User < Struct.new(
|
444
|
+
:user_name,
|
445
|
+
:user_id)
|
446
|
+
SENSITIVE = [:user_name]
|
447
|
+
include Aws::Structure
|
448
|
+
end
|
449
|
+
|
450
|
+
# The request failed because it contains a syntax error.
|
451
|
+
#
|
452
|
+
# @!attribute [rw] message
|
453
|
+
# @return [String]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] request_id
|
456
|
+
# The identifier for each request. This value is a globally unique ID
|
457
|
+
# that is generated by the Identity Store service for each sent
|
458
|
+
# request, and is then returned inside the exception if the request
|
459
|
+
# fails.
|
460
|
+
# @return [String]
|
461
|
+
#
|
462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15/ValidationException AWS API Documentation
|
463
|
+
#
|
464
|
+
class ValidationException < Struct.new(
|
465
|
+
:message,
|
466
|
+
:request_id)
|
467
|
+
SENSITIVE = []
|
468
|
+
include Aws::Structure
|
469
|
+
end
|
470
|
+
|
471
|
+
end
|
472
|
+
end
|