Class: Aws::MPA::Types::CreateApprovalTeamRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[:description, :tags]

Instance Attribute Summary collapse

Instance Attribute Details

#approval_strategyTypes::ApprovalStrategy

An ApprovalStrategy object. Contains details for how the team grants approval.



190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#approversArray<Types::ApprovalTeamRequestApprover>

An array of ApprovalTeamRequesterApprovers objects. Contains details for the approvers in the team.



190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services populates this field.

What is idempotency?

When you make a mutating API request, the request typically returns a result before the operation's asynchronous workflows have completed. Operations might also time out or encounter other server issues before they complete, even though the request has already returned a result. This could make it difficult to determine whether the request succeeded or not, and could lead to multiple retries to ensure that the operation completes successfully. However, if the original request and the subsequent retries are successful, the operation is completed multiple times. This means that you might create more resources than you intended.

Idempotency ensures that an API request completes no more than one time. With an idempotent request, if the original request completes successfully, any subsequent retries complete successfully without performing any further actions.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#descriptionString

Description for the team.

Returns:

  • (String)


190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#nameString

Name of the team.

Returns:

  • (String)


190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#policiesArray<Types::PolicyReference>

An array of PolicyReference objects. Contains a list of policies that define the permissions for team resources.

The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.

Returns:



190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end

#tagsHash<String,String>

Tags you want to attach to the team.

Returns:

  • (Hash<String,String>)


190
191
192
193
194
195
196
197
198
199
200
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 190

class CreateApprovalTeamRequest < Struct.new(
  :client_token,
  :approval_strategy,
  :approvers,
  :description,
  :policies,
  :name,
  :tags)
  SENSITIVE = [:description, :tags]
  include Aws::Structure
end