IAMRolesAnywhere / Paginator / ListTrustAnchors
ListTrustAnchors#
- class IAMRolesAnywhere.Paginator.ListTrustAnchors#
paginator = client.get_paginator('list_trust_anchors')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
IAMRolesAnywhere.Client.list_trust_anchors()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( pageSize=123, PaginationConfig={ 'MaxItems': 123, 'StartingToken': 'string' } )
- Parameters:
pageSize (integer) – The number of resources in the paginated list.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'trustAnchors': [ { 'createdAt': datetime(2015, 1, 1), 'enabled': True|False, 'name': 'string', 'notificationSettings': [ { 'channel': 'ALL', 'configuredBy': 'string', 'enabled': True|False, 'event': 'CA_CERTIFICATE_EXPIRY'|'END_ENTITY_CERTIFICATE_EXPIRY', 'threshold': 123 }, ], 'source': { 'sourceData': { 'acmPcaArn': 'string', 'x509CertificateData': 'string' }, 'sourceType': 'AWS_ACM_PCA'|'CERTIFICATE_BUNDLE'|'SELF_SIGNED_REPOSITORY' }, 'trustAnchorArn': 'string', 'trustAnchorId': 'string', 'updatedAt': datetime(2015, 1, 1) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
trustAnchors (list) –
A list of trust anchors.
(dict) –
The state of the trust anchor after a read or write operation.
createdAt (datetime) –
The ISO-8601 timestamp when the trust anchor was created.
enabled (boolean) –
Indicates whether the trust anchor is enabled.
name (string) –
The name of the trust anchor.
notificationSettings (list) –
A list of notification settings to be associated to the trust anchor.
(dict) –
The state of a notification setting.
A notification setting includes information such as event name, threshold, status of the notification setting, and the channel to notify.
channel (string) –
The specified channel of notification. IAM Roles Anywhere uses CloudWatch metrics, EventBridge, and Health Dashboard to notify for an event.
Note
In the absence of a specific channel, IAM Roles Anywhere applies this setting to ‘ALL’ channels.
configuredBy (string) –
The principal that configured the notification setting. For default settings configured by IAM Roles Anywhere, the value is
rolesanywhere.amazonaws.com
, and for customized notifications settings, it is the respective account ID.enabled (boolean) –
Indicates whether the notification setting is enabled.
event (string) –
The event to which this notification setting is applied.
threshold (integer) –
The number of days before a notification event.
source (dict) –
The trust anchor type and its related certificate data.
sourceData (dict) –
The data field of the trust anchor depending on its type.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
acmPcaArn
,x509CertificateData
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
acmPcaArn (string) –
The root certificate of the Private Certificate Authority specified by this ARN is used in trust validation for temporary credential requests. Included for trust anchors of type
AWS_ACM_PCA
.x509CertificateData (string) –
The PEM-encoded data for the certificate anchor. Included for trust anchors of type
CERTIFICATE_BUNDLE
.
sourceType (string) –
The type of the trust anchor.
trustAnchorArn (string) –
The ARN of the trust anchor.
trustAnchorId (string) –
The unique identifier of the trust anchor.
updatedAt (datetime) –
The ISO-8601 timestamp when the trust anchor was last updated.
NextToken (string) –
A token to resume pagination.