Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListResourceTelemetryForOrganization

Returns a list of telemetry configurations for AWS resources supported by telemetry config in the organization.

Request Syntax


POST /ListResourceTelemetryForOrganization HTTP/1.1
Content-type: application/json

{
   "AccountIdentifiers": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "ResourceIdentifierPrefix": "string",
   "ResourceTags": { 
      "string" : "string" 
   },
   "ResourceTypes": [ "string" ],
   "TelemetryConfigurationState": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AccountIdentifiers

A list of AWS accounts used to filter the resources to those associated with the specified accounts.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Length Constraints: Fixed length of 12.

Pattern: [0-9]{12}

Required: No

MaxResults

A number field used to limit the number of results within the returned list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 50.

Required: No

NextToken

The token for the next set of items to return. A previous call provides this token.

Type: String

Required: No

ResourceIdentifierPrefix

A string used to filter resources in the organization which have a ResourceIdentifier starting with the ResourceIdentifierPrefix.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 768.

Required: No

ResourceTags

A key-value pair to filter resources in the organization based on tags associated with the resource. Fore more information about tags, see What are tags?

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Required: No

ResourceTypes

A list of resource types used to filter resources in the organization. If this parameter is provided, the resources will be returned in the same order used in the request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Valid Values: AWS::EC2::Instance | AWS::EC2::VPC | AWS::Lambda::Function

Required: No

TelemetryConfigurationState

A key-value pair to filter resources in the organization based on the telemetry type and the state of the telemetry configuration. The key is the telemetry type and the value is the state.

Type: String to string map

Valid Keys: Logs | Metrics | Traces

Valid Values: Enabled | Disabled | NotApplicable

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "TelemetryConfigurations": [ 
      { 
         "AccountIdentifier": "string",
         "LastUpdateTimeStamp": number,
         "ResourceIdentifier": "string",
         "ResourceTags": { 
            "string" : "string" 
         },
         "ResourceType": "string",
         "TelemetryConfigurationState": { 
            "string" : "string" 
         }
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token for the next set of items to return. A previous call provides this token.

Type: String

TelemetryConfigurations

A list of telemetry configurations for AWS resources supported by telemetry config in the organization.

Type: Array of TelemetryConfiguration objects

Errors

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

AccessDeniedException

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

HTTP Status Code: 400

InternalServerException

Indicates the request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ValidationException

Indicates input validation failed. Check your request parameters and retry the request.

HTTP Status Code: 400