TagOpenIDConnectProvider - AWS Identity and Access Management

TagOpenIDConnectProvider

Adds one or more tags to an OpenID Connect (OIDC)-compatible identity provider. For more information about these providers, see About web identity federation. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Include tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an OIDC provider that has a specified tag attached. For examples of policies that show how to use tags to control access, see Control access using IAM tags in the IAM User Guide.

Note
  • If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

  • AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

OpenIDConnectProviderArn

The ARN of the OIDC identity provider in IAM to which you want to add tags.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Required: Yes

Tags.member.N

The list of tags that you want to attach to the OIDC identity provider in IAM. Each tag consists of a key name and an associated value.

Type: Array of Tag objects

Array Members: Maximum number of 50 items.

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModification

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

HTTP Status Code: 409

InvalidInput

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

HTTP Status Code: 400

LimitExceeded

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

HTTP Status Code: 409

NoSuchEntity

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 404

ServiceFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples

Example

The following example is formatted with line breaks for legibility.

The following example shows how to add tags to an existing OIDC provider.

Sample Request

POST / HTTP/1.1 Host: https://iam.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.11.143 Python/3.6.1 Linux/3.2.45-0.6.wd.865.49.315.metal1.x86_64 botocore/1.7.1 X-Amz-Date: 20170929T181747Z Authorization: <auth details> Content-Length: 99 Content-Type: application/x-www-form-urlencoded Action=TagOpenIDConnectProvider&Version=2010-05-08&OpenIDConnectProviderArn=arn:aws:iam::123456789012:oidc-provider/GoogleProvider &Tags.member.1.Key=Dept&Tags.member.1.Value=Accounting &Tags.member.2.Key=Cost Center&Tags.member.2.Value=12345

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE Content-Type: text/xml Content-Length: 194 Date: Fri, 29 Sep 2017 18:17:47 GMT <TagOpenIDConnectProviderResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/"> <ResponseMetadata> <RequestId>EXAMPLE8-90ab-cdef-fedc-ba987EXAMPLE</RequestId> </ResponseMetadata> </TagOpenIDConnectProviderResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: