Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed information about the Amazon AppFlow API operations, data types, and errors.
Amazon AppFlow is a fully managed integration service that enables you to securely transfer data between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow, and AWS services like Amazon S3 and Amazon Redshift.
Use the following links to get started on the Amazon AppFlow API:
Actions: An alphabetical list of all Amazon AppFlow API operations.
Data types: An alphabetical list of all Amazon AppFlow data types.
Common parameters: Parameters that all Query operations can use.
Common errors: Client and server errors that all operations can return.
If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User Guide.
Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as auth-code and redirecturi) with the connector-specific ConnectorProfileProperties when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth documentation.
Creates a new connector profile associated with your AWS account. There is a soft quota of 100 connector profiles per AWS account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel.
", + "CreateFlow": "Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once.
", + "DeleteConnectorProfile": "Enables you to delete an existing connector profile.
", + "DeleteFlow": "Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time.
", + "DescribeConnectorEntity": "Provides details regarding the entity used with the connector, with a description of the data model for each entity.
", + "DescribeConnectorProfiles": " Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result.
If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.
Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a nextToken object, which can be be passed in to the next call to the DescribeConnectors API operation to retrieve the next page.
Provides a description of the specified flow.
", + "DescribeFlowExecutionRecords": "Fetches the execution history of the flow.
", + "ListConnectorEntities": "Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.
", + "ListFlows": "Lists all of the flows associated with your account.
", + "ListTagsForResource": "Retrieves the tags that are associated with a specified flow.
", + "StartFlow": "Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
", + "StopFlow": " Deactivates the existing flow. For on-demand flows, this operation returns an unsupportedOperationException error message. For schedule and event-triggered flows, this operation deactivates the flow.
Applies a tag to the specified flow.
", + "UntagResource": "Removes a tag from the specified flow.
", + "UpdateConnectorProfile": "Updates a given connector profile associated with your account.
", + "UpdateFlow": "Updates an existing flow.
" + }, + "shapes": { + "ARN": { + "base": null, + "refs": { + "ConnectorProfile$credentialsArn": "The Amazon Resource Name (ARN) of the connector profile credentials.
", + "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the specified flow.
", + "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the flow that you want to tag.
", + "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the flow that you want to untag.
" + } + }, + "AccessKeyId": { + "base": null, + "refs": { + "InforNexusConnectorProfileCredentials$accessKeyId": "The Access Key portion of the credentials.
" + } + }, + "AccessToken": { + "base": null, + "refs": { + "GoogleAnalyticsConnectorProfileCredentials$accessToken": "The credentials used to access protected Google Analytics resources.
", + "MarketoConnectorProfileCredentials$accessToken": "The credentials used to access protected Marketo resources.
", + "SalesforceConnectorProfileCredentials$accessToken": "The credentials used to access protected Salesforce resources.
", + "SlackConnectorProfileCredentials$accessToken": "The credentials used to access protected Slack resources.
", + "ZendeskConnectorProfileCredentials$accessToken": "The credentials used to access protected Zendesk resources.
" + } + }, + "AccountName": { + "base": null, + "refs": { + "SnowflakeConnectorProfileProperties$accountName": "The name of the account.
" + } + }, + "AggregationConfig": { + "base": "The aggregation settings that you can use to customize the output format of your flow data.
", + "refs": { + "S3OutputFormatConfig$aggregationConfig": null + } + }, + "AggregationType": { + "base": null, + "refs": { + "AggregationConfig$aggregationType": "Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated.
" + } + }, + "AmplitudeConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Amplitude": "The operation to be performed on the provided Amplitude source fields.
" + } + }, + "AmplitudeConnectorProfileCredentials": { + "base": "The connector-specific credentials required when using Amplitude.
", + "refs": { + "ConnectorProfileCredentials$Amplitude": "The connector-specific credentials required when using Amplitude.
" + } + }, + "AmplitudeConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Amplitude.
", + "refs": { + "ConnectorProfileProperties$Amplitude": "The connector-specific properties required by Amplitude.
" + } + }, + "AmplitudeMetadata": { + "base": "The connector metadata specific to Amplitude.
", + "refs": { + "ConnectorMetadata$Amplitude": "The connector metadata specific to Amplitude.
" + } + }, + "AmplitudeSourceProperties": { + "base": "The properties that are applied when Amplitude is being used as a source.
", + "refs": { + "SourceConnectorProperties$Amplitude": "Specifies the information that is required for querying Amplitude.
" + } + }, + "ApiKey": { + "base": null, + "refs": { + "AmplitudeConnectorProfileCredentials$apiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
", + "DatadogConnectorProfileCredentials$apiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
", + "SingularConnectorProfileCredentials$apiKey": "A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API.
" + } + }, + "ApiSecretKey": { + "base": null, + "refs": { + "TrendmicroConnectorProfileCredentials$apiSecretKey": "The Secret Access Key portion of the credentials.
" + } + }, + "ApiToken": { + "base": null, + "refs": { + "DynatraceConnectorProfileCredentials$apiToken": "The API tokens used by Dynatrace API to authenticate various API calls.
" + } + }, + "ApplicationKey": { + "base": null, + "refs": { + "DatadogConnectorProfileCredentials$applicationKey": "Application keys, in conjunction with your API key, give you full access to Datadog’s programmatic API. Application keys are associated with the user account that created them. The application key is used to log all requests made to the API.
" + } + }, + "AuthCode": { + "base": null, + "refs": { + "ConnectorOAuthRequest$authCode": "The code provided by the connector when it has been authenticated via the connected app.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "ConnectorConfiguration$canUseAsSource": "Specifies whether the connector can be used as a source.
", + "ConnectorConfiguration$canUseAsDestination": "Specifies whether the connector can be used as a destination.
", + "ConnectorConfiguration$isPrivateLinkEnabled": "Specifies if PrivateLink is enabled for that connector.
", + "ConnectorConfiguration$isPrivateLinkEndpointUrlRequired": "Specifies if a PrivateLink endpoint URL is required.
", + "ConnectorEntity$hasNestedEntities": " Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = \"the_current_entity_name_with_hasNestedEntities_true\", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.
Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
", + "DeleteFlowRequest$forceDelete": "Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
", + "DestinationFieldProperties$isCreatable": "Specifies if the destination field can be created by the current user.
", + "DestinationFieldProperties$isNullable": "Specifies if the destination field can have a null value.
", + "DestinationFieldProperties$isUpsertable": "Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
", + "ErrorHandlingConfig$failOnFirstDestinationError": "Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination.
", + "SalesforceConnectorProfileProperties$isSandboxEnvironment": "Indicates whether the connector profile applies to a sandbox or production environment.
", + "SalesforceSourceProperties$enableDynamicFieldUpdate": "The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
", + "SalesforceSourceProperties$includeDeletedRecords": "Indicates whether Amazon AppFlow includes deleted files in the flow run.
", + "SourceFieldProperties$isRetrievable": "Indicates whether the field can be returned in a search result.
", + "SourceFieldProperties$isQueryable": "Indicates if the field can be queried.
" + } + }, + "BucketName": { + "base": null, + "refs": { + "ErrorHandlingConfig$bucketName": "Specifies the name of the Amazon S3 bucket.
", + "RedshiftConnectorProfileProperties$bucketName": "A name for the associated Amazon S3 bucket.
", + "RedshiftDestinationProperties$intermediateBucketName": "The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
", + "S3DestinationProperties$bucketName": "The Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
", + "S3SourceProperties$bucketName": "The Amazon S3 bucket name where the source files are stored.
", + "SnowflakeConnectorProfileProperties$bucketName": "The name of the Amazon S3 bucket associated with Snowflake.
", + "SnowflakeDestinationProperties$intermediateBucketName": "The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
" + } + }, + "BucketPrefix": { + "base": null, + "refs": { + "ErrorHandlingConfig$bucketPrefix": "Specifies the Amazon S3 bucket prefix.
", + "RedshiftConnectorProfileProperties$bucketPrefix": "The object key for the destination bucket in which Amazon AppFlow places the files.
", + "RedshiftDestinationProperties$bucketPrefix": "The object key for the bucket in which Amazon AppFlow places the destination files.
", + "S3DestinationProperties$bucketPrefix": "The object key for the destination bucket in which Amazon AppFlow places the files.
", + "S3SourceProperties$bucketPrefix": "The object key for the Amazon S3 bucket in which the source files are stored.
", + "SnowflakeConnectorProfileProperties$bucketPrefix": "The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
", + "SnowflakeDestinationProperties$bucketPrefix": "The object key for the destination bucket in which Amazon AppFlow places the files.
" + } + }, + "ClientId": { + "base": null, + "refs": { + "GoogleAnalyticsConnectorProfileCredentials$clientId": "The identifier for the desired client.
", + "MarketoConnectorProfileCredentials$clientId": "The identifier for the desired client.
", + "SlackConnectorProfileCredentials$clientId": "The identifier for the client.
", + "ZendeskConnectorProfileCredentials$clientId": "The identifier for the desired client.
" + } + }, + "ClientSecret": { + "base": null, + "refs": { + "GoogleAnalyticsConnectorProfileCredentials$clientSecret": "The client secret used by the oauth client to authenticate to the authorization server.
", + "MarketoConnectorProfileCredentials$clientSecret": "The client secret used by the oauth client to authenticate to the authorization server.
", + "SlackConnectorProfileCredentials$clientSecret": "The client secret used by the oauth client to authenticate to the authorization server.
", + "ZendeskConnectorProfileCredentials$clientSecret": "The client secret used by the oauth client to authenticate to the authorization server.
" + } + }, + "ConflictException": { + "base": "There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.
", + "refs": { + } + }, + "ConnectionMode": { + "base": null, + "refs": { + "ConnectorProfile$connectionMode": "Indicates the connection mode and if it is public or private.
", + "CreateConnectorProfileRequest$connectionMode": "Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet.
", + "UpdateConnectorProfileRequest$connectionMode": "Indicates the connection mode and if it is public or private.
" + } + }, + "ConnectorAuthenticationException": { + "base": "An error occurred when authenticating with the connector endpoint.
", + "refs": { + } + }, + "ConnectorConfiguration": { + "base": "The configuration settings related to a given connector.
", + "refs": { + "ConnectorConfigurationsMap$value": null + } + }, + "ConnectorConfigurationsMap": { + "base": null, + "refs": { + "DescribeConnectorsResponse$connectorConfigurations": "The configuration that is applied to the connectors used in the flow.
" + } + }, + "ConnectorEntity": { + "base": "The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.
", + "refs": { + "ConnectorEntityList$member": null + } + }, + "ConnectorEntityField": { + "base": "Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.
", + "refs": { + "ConnectorEntityFieldList$member": null + } + }, + "ConnectorEntityFieldList": { + "base": null, + "refs": { + "DescribeConnectorEntityResponse$connectorEntityFields": "Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.
" + } + }, + "ConnectorEntityList": { + "base": null, + "refs": { + "ConnectorEntityMap$value": null + } + }, + "ConnectorEntityMap": { + "base": null, + "refs": { + "ListConnectorEntitiesResponse$connectorEntityMap": " The response of ListConnectorEntities lists entities grouped by category. This map's key represents the group name, and its value contains the list of entities belonging to that group.
A structure to specify connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.
Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
", + "refs": { + "GoogleAnalyticsConnectorProfileCredentials$oAuthRequest": "The oauth requirement needed to request security tokens from the connector endpoint.
", + "MarketoConnectorProfileCredentials$oAuthRequest": "The oauth requirement needed to request security tokens from the connector endpoint.
", + "SalesforceConnectorProfileCredentials$oAuthRequest": "The oauth requirement needed to request security tokens from the connector endpoint.
", + "SlackConnectorProfileCredentials$oAuthRequest": "The oauth requirement needed to request security tokens from the connector endpoint.
", + "ZendeskConnectorProfileCredentials$oAuthRequest": "The oauth requirement needed to request security tokens from the connector endpoint.
" + } + }, + "ConnectorOperator": { + "base": "The operation to be performed on the provided source fields.
", + "refs": { + "Task$connectorOperator": "The operation to be performed on the provided source fields.
" + } + }, + "ConnectorProfile": { + "base": " Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.
The Amazon Resource Name (ARN) of the connector profile.
", + "CreateConnectorProfileResponse$connectorProfileArn": "The Amazon Resource Name (ARN) of the connector profile.
", + "UpdateConnectorProfileResponse$connectorProfileArn": "The Amazon Resource Name (ARN) of the connector profile.
" + } + }, + "ConnectorProfileConfig": { + "base": "Defines the connector-specific configuration and credentials for the connector profile.
", + "refs": { + "CreateConnectorProfileRequest$connectorProfileConfig": "Defines the connector-specific configuration and credentials.
", + "UpdateConnectorProfileRequest$connectorProfileConfig": "Defines the connector-specific profile configuration and credentials.
" + } + }, + "ConnectorProfileCredentials": { + "base": "The connector-specific credentials required by a connector.
", + "refs": { + "ConnectorProfileConfig$connectorProfileCredentials": "The connector-specific credentials required by each connector.
" + } + }, + "ConnectorProfileDetailList": { + "base": null, + "refs": { + "DescribeConnectorProfilesResponse$connectorProfileDetails": "Returns information about the connector profiles associated with the flow.
" + } + }, + "ConnectorProfileName": { + "base": null, + "refs": { + "ConnectorProfile$connectorProfileName": " The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
The name of the connector profile. The name is unique for each ConnectorProfile in your AWS account.
The name of the connector profile. The name is unique for each ConnectorProfile in your account.
The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
The name of the connector profile. This name must be unique for each connector profile in the AWS account.
", + "ListConnectorEntitiesRequest$connectorProfileName": " The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector.
The name of the connector profile. This name must be unique for each connector profile in the AWS account.
", + "UpdateConnectorProfileRequest$connectorProfileName": " The name of the connector profile and is unique for each ConnectorProfile in the AWS Account.
The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account.
The connector-specific profile properties required by each connector.
", + "refs": { + "ConnectorProfile$connectorProfileProperties": "The connector-specific properties of the profile configuration.
", + "ConnectorProfileConfig$connectorProfileProperties": "The connector-specific properties of the profile configuration.
" + } + }, + "ConnectorServerException": { + "base": "An error occurred when retrieving data from the connector endpoint.
", + "refs": { + } + }, + "ConnectorType": { + "base": null, + "refs": { + "ConnectorConfigurationsMap$key": null, + "ConnectorProfile$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
", + "ConnectorTypeList$member": null, + "CreateConnectorProfileRequest$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
", + "DescribeConnectorEntityRequest$connectorType": "The type of connector application, such as Salesforce, Amplitude, and so on.
", + "DescribeConnectorProfilesRequest$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
", + "DestinationFlowConfig$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
", + "FlowDefinition$sourceConnectorType": "Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
", + "FlowDefinition$destinationConnectorType": "Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
", + "ListConnectorEntitiesRequest$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
", + "SourceFlowConfig$connectorType": "The type of connector, such as Salesforce, Amplitude, and so on.
" + } + }, + "ConnectorTypeList": { + "base": null, + "refs": { + "ConnectorConfiguration$supportedDestinationConnectors": "Lists the connectors that are available for use as destinations.
", + "DescribeConnectorsRequest$connectorTypes": "The type of connector, such as Salesforce, Amplitude, and so on.
" + } + }, + "CreateConnectorProfileRequest": { + "base": null, + "refs": { + } + }, + "CreateConnectorProfileResponse": { + "base": null, + "refs": { + } + }, + "CreateFlowRequest": { + "base": null, + "refs": { + } + }, + "CreateFlowResponse": { + "base": null, + "refs": { + } + }, + "CreatedBy": { + "base": null, + "refs": { + "DescribeFlowResponse$createdBy": "The ARN of the user who created the flow.
", + "FlowDefinition$createdBy": "The ARN of the user who created the flow.
" + } + }, + "DataPullMode": { + "base": null, + "refs": { + "ScheduledTriggerProperties$dataPullMode": "Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
" + } + }, + "DatabaseUrl": { + "base": null, + "refs": { + "RedshiftConnectorProfileProperties$databaseUrl": "The JDBC URL of the Amazon Redshift cluster.
" + } + }, + "DatadogConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Datadog": "The operation to be performed on the provided Datadog source fields.
" + } + }, + "DatadogConnectorProfileCredentials": { + "base": "The connector-specific credentials required by Datadog.
", + "refs": { + "ConnectorProfileCredentials$Datadog": "The connector-specific credentials required when using Datadog.
" + } + }, + "DatadogConnectorProfileProperties": { + "base": "The connector-specific profile properties required by Datadog.
", + "refs": { + "ConnectorProfileProperties$Datadog": "The connector-specific properties required by Datadog.
" + } + }, + "DatadogMetadata": { + "base": "The connector metadata specific to Datadog.
", + "refs": { + "ConnectorMetadata$Datadog": "The connector metadata specific to Datadog.
" + } + }, + "DatadogSourceProperties": { + "base": "The properties that are applied when Datadog is being used as a source.
", + "refs": { + "SourceConnectorProperties$Datadog": "Specifies the information that is required for querying Datadog.
" + } + }, + "Date": { + "base": null, + "refs": { + "ConnectorProfile$createdAt": "Specifies when the connector profile was created.
", + "ConnectorProfile$lastUpdatedAt": "Specifies when the connector profile was last updated.
", + "DescribeFlowResponse$createdAt": "Specifies when the flow was created.
", + "DescribeFlowResponse$lastUpdatedAt": "Specifies when the flow was last updated.
", + "ExecutionDetails$mostRecentExecutionTime": "Specifies the time of the most recent flow run.
", + "ExecutionRecord$startedAt": "Specifies the start time of the flow run.
", + "ExecutionRecord$lastUpdatedAt": "Specifies the time of the most recent update.
", + "FlowDefinition$createdAt": "Specifies when the flow was created.
", + "FlowDefinition$lastUpdatedAt": "Specifies when the flow was last updated.
", + "ScheduledTriggerProperties$scheduleStartTime": "Specifies the scheduled start time for a schedule-triggered flow.
", + "ScheduledTriggerProperties$scheduleEndTime": "Specifies the scheduled end time for a schedule-triggered flow.
" + } + }, + "DeleteConnectorProfileRequest": { + "base": null, + "refs": { + } + }, + "DeleteConnectorProfileResponse": { + "base": null, + "refs": { + } + }, + "DeleteFlowRequest": { + "base": null, + "refs": { + } + }, + "DeleteFlowResponse": { + "base": null, + "refs": { + } + }, + "DescribeConnectorEntityRequest": { + "base": null, + "refs": { + } + }, + "DescribeConnectorEntityResponse": { + "base": null, + "refs": { + } + }, + "DescribeConnectorProfilesRequest": { + "base": null, + "refs": { + } + }, + "DescribeConnectorProfilesResponse": { + "base": null, + "refs": { + } + }, + "DescribeConnectorsRequest": { + "base": null, + "refs": { + } + }, + "DescribeConnectorsResponse": { + "base": null, + "refs": { + } + }, + "DescribeFlowExecutionRecordsRequest": { + "base": null, + "refs": { + } + }, + "DescribeFlowExecutionRecordsResponse": { + "base": null, + "refs": { + } + }, + "DescribeFlowRequest": { + "base": null, + "refs": { + } + }, + "DescribeFlowResponse": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "ConnectorEntityField$description": "A description of the connector entity field.
" + } + }, + "DestinationConnectorProperties": { + "base": "This stores the information that is required to query a particular connector.
", + "refs": { + "DestinationFlowConfig$destinationConnectorProperties": "This stores the information that is required to query a particular connector.
" + } + }, + "DestinationField": { + "base": null, + "refs": { + "Task$destinationField": "A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
" + } + }, + "DestinationFieldProperties": { + "base": "The properties that can be applied to a field when connector is being used as a destination.
", + "refs": { + "ConnectorEntityField$destinationProperties": "The properties applied to a field when the connector is being used as a destination.
" + } + }, + "DestinationFlowConfig": { + "base": "Contains information about the configuration of destination connectors present in the flow.
", + "refs": { + "DestinationFlowConfigList$member": null + } + }, + "DestinationFlowConfigList": { + "base": null, + "refs": { + "CreateFlowRequest$destinationFlowConfigList": "The configuration that controls how Amazon AppFlow places data in the destination connector.
", + "DescribeFlowResponse$destinationFlowConfigList": "The configuration that controls how Amazon AppFlow transfers data to the destination connector.
", + "UpdateFlowRequest$destinationFlowConfigList": "The configuration that controls how Amazon AppFlow transfers data to the destination connector.
" + } + }, + "DynatraceConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Dynatrace": "The operation to be performed on the provided Dynatrace source fields.
" + } + }, + "DynatraceConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required by Dynatrace.
", + "refs": { + "ConnectorProfileCredentials$Dynatrace": "The connector-specific credentials required when using Dynatrace.
" + } + }, + "DynatraceConnectorProfileProperties": { + "base": "The connector-specific profile properties required by Dynatrace.
", + "refs": { + "ConnectorProfileProperties$Dynatrace": "The connector-specific properties required by Dynatrace.
" + } + }, + "DynatraceMetadata": { + "base": "The connector metadata specific to Dynatrace.
", + "refs": { + "ConnectorMetadata$Dynatrace": "The connector metadata specific to Dynatrace.
" + } + }, + "DynatraceSourceProperties": { + "base": "The properties that are applied when Dynatrace is being used as a source.
", + "refs": { + "SourceConnectorProperties$Dynatrace": "Specifies the information that is required for querying Dynatrace.
" + } + }, + "EntitiesPath": { + "base": null, + "refs": { + "ListConnectorEntitiesRequest$entitiesPath": " This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.
The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the Amazon Redshift destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the Salesforce destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. ErrorHandlingConfig is a part of the destination connector details.
Provides details in the event of a failed flow, including the failure count and the related error messages.
", + "refs": { + "ExecutionResult$errorInfo": "Provides any error message information related to the flow run.
" + } + }, + "ErrorMessage": { + "base": null, + "refs": { + "ConflictException$message": null, + "ConnectorAuthenticationException$message": null, + "ConnectorServerException$message": null, + "InternalServerException$message": null, + "ResourceNotFoundException$message": null, + "ServiceQuotaExceededException$message": null, + "UnsupportedOperationException$message": null, + "ValidationException$message": null + } + }, + "EventBridgeDestinationProperties": { + "base": "The properties that are applied when Amazon EventBridge is being used as a destination.
", + "refs": { + "DestinationConnectorProperties$EventBridge": "The properties required to query Amazon EventBridge.
" + } + }, + "EventBridgeMetadata": { + "base": "The connector metadata specific to Amazon EventBridge.
", + "refs": { + "ConnectorMetadata$EventBridge": "The connector metadata specific to Amazon EventBridge.
" + } + }, + "ExecutionDetails": { + "base": "Describes the details of the flow run, including the timestamp, status, and message.
", + "refs": { + "DescribeFlowResponse$lastRunExecutionDetails": "Describes the details of the most recent flow run.
", + "FlowDefinition$lastRunExecutionDetails": "Describes the details of the most recent flow run.
" + } + }, + "ExecutionId": { + "base": null, + "refs": { + "ExecutionRecord$executionId": "Specifies the identifier of the given flow run.
" + } + }, + "ExecutionMessage": { + "base": null, + "refs": { + "ErrorInfo$executionMessage": "Specifies the error message that appears if a flow fails.
" + } + }, + "ExecutionRecord": { + "base": "Specifies information about the past flow run instances for a given flow.
", + "refs": { + "FlowExecutionList$member": null + } + }, + "ExecutionResult": { + "base": "Specifies the end result of the flow run.
", + "refs": { + "ExecutionRecord$executionResult": "Describes the result of the given flow run.
" + } + }, + "ExecutionStatus": { + "base": null, + "refs": { + "ExecutionDetails$mostRecentExecutionStatus": "Specifies the status of the most recent flow run.
", + "ExecutionRecord$executionStatus": "Specifies the flow run status and whether it is in progress, has completed successfully, or has failed.
" + } + }, + "FieldType": { + "base": null, + "refs": { + "FieldTypeDetails$fieldType": "The type of field, such as string, integer, date, and so on.
" + } + }, + "FieldTypeDetails": { + "base": "Contains details regarding the supported field type and the operators that can be applied for filtering.
", + "refs": { + "SupportedFieldTypeDetails$v1": " The initial supported version for fieldType. If this is later changed to a different version, v2 will be introduced.
Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
" + } + }, + "FilterOperatorList": { + "base": null, + "refs": { + "FieldTypeDetails$filterOperators": "The list of operators supported by a field.
" + } + }, + "FlowArn": { + "base": null, + "refs": { + "CreateFlowResponse$flowArn": "The flow's Amazon Resource Name (ARN).
", + "DescribeFlowResponse$flowArn": "The flow's Amazon Resource Name (ARN).
", + "FlowDefinition$flowArn": "The flow's Amazon Resource Name (ARN).
", + "StartFlowResponse$flowArn": "The flow's Amazon Resource Name (ARN).
", + "StopFlowResponse$flowArn": "The flow's Amazon Resource Name (ARN).
" + } + }, + "FlowDefinition": { + "base": "The properties of the flow, such as its source, destination, trigger type, and so on.
", + "refs": { + "FlowList$member": null + } + }, + "FlowDescription": { + "base": null, + "refs": { + "CreateFlowRequest$description": "A description of the flow you want to create.
", + "DescribeFlowResponse$description": "A description of the flow.
", + "FlowDefinition$description": "A user-entered description of the flow.
", + "UpdateFlowRequest$description": "A description of the flow.
" + } + }, + "FlowExecutionList": { + "base": null, + "refs": { + "DescribeFlowExecutionRecordsResponse$flowExecutions": "Returns a list of all instances when this flow was run.
" + } + }, + "FlowList": { + "base": null, + "refs": { + "ListFlowsResponse$flows": "The list of flows associated with your account.
" + } + }, + "FlowName": { + "base": null, + "refs": { + "CreateFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "DeleteFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "DescribeFlowExecutionRecordsRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "DescribeFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "DescribeFlowResponse$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "FlowDefinition$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "StartFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "StopFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
", + "UpdateFlowRequest$flowName": "The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
" + } + }, + "FlowStatus": { + "base": null, + "refs": { + "CreateFlowResponse$flowStatus": "Indicates the current status of the flow.
", + "DescribeFlowResponse$flowStatus": "Indicates the current status of the flow.
", + "FlowDefinition$flowStatus": "Indicates the current status of the flow.
", + "StartFlowResponse$flowStatus": "Indicates the current status of the flow.
", + "StopFlowResponse$flowStatus": "Indicates the current status of the flow.
", + "UpdateFlowResponse$flowStatus": "Indicates the current status of the flow.
" + } + }, + "FlowStatusMessage": { + "base": null, + "refs": { + "DescribeFlowResponse$flowStatusMessage": "Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows.
" + } + }, + "GoogleAnalyticsConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$GoogleAnalytics": "The operation to be performed on the provided Google Analytics source fields.
" + } + }, + "GoogleAnalyticsConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required by Google Analytics.
", + "refs": { + "ConnectorProfileCredentials$GoogleAnalytics": "The connector-specific credentials required when using Google Analytics.
" + } + }, + "GoogleAnalyticsConnectorProfileProperties": { + "base": "The connector-specific profile properties required by Google Analytics.
", + "refs": { + "ConnectorProfileProperties$GoogleAnalytics": "The connector-specific properties required Google Analytics.
" + } + }, + "GoogleAnalyticsMetadata": { + "base": "The connector metadata specific to Google Analytics.
", + "refs": { + "ConnectorMetadata$GoogleAnalytics": "The connector metadata specific to Google Analytics.
" + } + }, + "GoogleAnalyticsSourceProperties": { + "base": "The properties that are applied when Google Analytics is being used as a source.
", + "refs": { + "SourceConnectorProperties$GoogleAnalytics": "Specifies the information that is required for querying Google Analytics.
" + } + }, + "Group": { + "base": null, + "refs": { + "ConnectorEntityMap$key": null + } + }, + "Identifier": { + "base": null, + "refs": { + "ConnectorEntityField$identifier": "The unique identifier of the connector field.
" + } + }, + "InforNexusConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$InforNexus": "The operation to be performed on the provided Infor Nexus source fields.
" + } + }, + "InforNexusConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required by Infor Nexus.
", + "refs": { + "ConnectorProfileCredentials$InforNexus": "The connector-specific credentials required when using Infor Nexus.
" + } + }, + "InforNexusConnectorProfileProperties": { + "base": "The connector-specific profile properties required by Infor Nexus.
", + "refs": { + "ConnectorProfileProperties$InforNexus": "The connector-specific properties required by Infor Nexus.
" + } + }, + "InforNexusMetadata": { + "base": "The connector metadata specific to Infor Nexus.
", + "refs": { + "ConnectorMetadata$InforNexus": "The connector metadata specific to Infor Nexus.
" + } + }, + "InforNexusSourceProperties": { + "base": "The properties that are applied when Infor Nexus is being used as a source.
", + "refs": { + "SourceConnectorProperties$InforNexus": "Specifies the information that is required for querying Infor Nexus.
" + } + }, + "InstanceUrl": { + "base": null, + "refs": { + "DatadogConnectorProfileProperties$instanceUrl": "The location of the Datadog resource.
", + "DynatraceConnectorProfileProperties$instanceUrl": "The location of the Dynatrace resource.
", + "InforNexusConnectorProfileProperties$instanceUrl": "The location of the Infor Nexus resource.
", + "MarketoConnectorProfileProperties$instanceUrl": "The location of the Marketo resource.
", + "SalesforceConnectorProfileProperties$instanceUrl": "The location of the Salesforce resource.
", + "ServiceNowConnectorProfileProperties$instanceUrl": "The location of the ServiceNow resource.
", + "SlackConnectorProfileProperties$instanceUrl": "The location of the Slack resource.
", + "VeevaConnectorProfileProperties$instanceUrl": "The location of the Veeva resource.
", + "ZendeskConnectorProfileProperties$instanceUrl": "The location of the Zendesk resource.
" + } + }, + "InternalServerException": { + "base": "An internal service error occurred during the processing of your request. Try again later.
", + "refs": { + } + }, + "KMSArn": { + "base": null, + "refs": { + "CreateConnectorProfileRequest$kmsArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
", + "CreateFlowRequest$kmsArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
", + "DescribeFlowResponse$kmsArn": "The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
" + } + }, + "Key": { + "base": null, + "refs": { + "InforNexusConnectorProfileCredentials$secretAccessKey": "The secret key used to sign requests.
", + "InforNexusConnectorProfileCredentials$datakey": "The encryption keys used to encrypt data.
" + } + }, + "Label": { + "base": null, + "refs": { + "ConnectorEntity$label": "The label applied to the connector entity.
", + "ConnectorEntityField$label": "The label applied to a connector entity field.
" + } + }, + "ListConnectorEntitiesRequest": { + "base": null, + "refs": { + } + }, + "ListConnectorEntitiesResponse": { + "base": null, + "refs": { + } + }, + "ListFlowsRequest": { + "base": null, + "refs": { + } + }, + "ListFlowsResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "Long": { + "base": null, + "refs": { + "ErrorInfo$putFailuresCount": "Specifies the failure count for the attempted flow.
", + "ExecutionResult$bytesProcessed": "The total number of bytes processed by the flow run.
", + "ExecutionResult$bytesWritten": "The total number of bytes written as a result of the flow run.
", + "ExecutionResult$recordsProcessed": "The number of records processed in the flow run.
" + } + }, + "MarketoConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Marketo": "The operation to be performed on the provided Marketo source fields.
" + } + }, + "MarketoConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required by Marketo.
", + "refs": { + "ConnectorProfileCredentials$Marketo": "The connector-specific credentials required when using Marketo.
" + } + }, + "MarketoConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Marketo.
", + "refs": { + "ConnectorProfileProperties$Marketo": "The connector-specific properties required by Marketo.
" + } + }, + "MarketoMetadata": { + "base": "The connector metadata specific to Marketo.
", + "refs": { + "ConnectorMetadata$Marketo": "The connector metadata specific to Marketo.
" + } + }, + "MarketoSourceProperties": { + "base": "The properties that are applied when Marketo is being used as a source.
", + "refs": { + "SourceConnectorProperties$Marketo": "Specifies the information that is required for querying Marketo.
" + } + }, + "MaxResults": { + "base": null, + "refs": { + "DescribeConnectorProfilesRequest$maxResults": " Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
Specifies the maximum number of items that should be returned in the result set.
" + } + }, + "MostRecentExecutionMessage": { + "base": null, + "refs": { + "ExecutionDetails$mostRecentExecutionMessage": "Describes the details of the most recent flow run.
" + } + }, + "Name": { + "base": null, + "refs": { + "ConnectorEntity$name": "The name of the connector entity.
", + "DescribeConnectorEntityRequest$connectorEntityName": "The entity name for that connector.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "DescribeConnectorProfilesRequest$nextToken": "The pagination token for the next page of data.
", + "DescribeConnectorProfilesResponse$nextToken": " The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
The pagination token for the next page of data.
", + "DescribeConnectorsResponse$nextToken": "The pagination token for the next page of data.
", + "DescribeFlowExecutionRecordsRequest$nextToken": "The pagination token for the next page of data.
", + "DescribeFlowExecutionRecordsResponse$nextToken": "The pagination token for the next page of data.
", + "ListFlowsRequest$nextToken": "The pagination token for next page of data.
", + "ListFlowsResponse$nextToken": "The pagination token for next page of data.
" + } + }, + "OAuthScope": { + "base": null, + "refs": { + "OAuthScopeList$member": null + } + }, + "OAuthScopeList": { + "base": null, + "refs": { + "GoogleAnalyticsMetadata$oAuthScopes": "The desired authorization scope for the Google Analytics account.
", + "SalesforceMetadata$oAuthScopes": "The desired authorization scope for the Salesforce account.
", + "SlackMetadata$oAuthScopes": "The desired authorization scope for the Slack account.
", + "ZendeskMetadata$oAuthScopes": "The desired authorization scope for the Zendesk account.
" + } + }, + "Object": { + "base": null, + "refs": { + "AmplitudeSourceProperties$object": "The object specified in the Amplitude flow source.
", + "DatadogSourceProperties$object": "The object specified in the Datadog flow source.
", + "DynatraceSourceProperties$object": "The object specified in the Dynatrace flow source.
", + "EventBridgeDestinationProperties$object": "The object specified in the Amazon EventBridge flow destination.
", + "GoogleAnalyticsSourceProperties$object": "The object specified in the Google Analytics flow source.
", + "InforNexusSourceProperties$object": "The object specified in the Infor Nexus flow source.
", + "MarketoSourceProperties$object": "The object specified in the Marketo flow source.
", + "RedshiftDestinationProperties$object": "The object specified in the Amazon Redshift flow destination.
", + "SalesforceDestinationProperties$object": "The object specified in the Salesforce flow destination.
", + "SalesforceSourceProperties$object": "The object specified in the Salesforce flow source.
", + "ServiceNowSourceProperties$object": "The object specified in the ServiceNow flow source.
", + "SingularSourceProperties$object": "The object specified in the Singular flow source.
", + "SlackSourceProperties$object": "The object specified in the Slack flow source.
", + "SnowflakeDestinationProperties$object": "The object specified in the Snowflake flow destination.
", + "TrendmicroSourceProperties$object": "The object specified in the Trend Micro flow source.
", + "VeevaSourceProperties$object": "The object specified in the Veeva flow source.
", + "ZendeskSourceProperties$object": "The object specified in the Zendesk flow source.
" + } + }, + "Operator": { + "base": null, + "refs": { + "FilterOperatorList$member": null + } + }, + "OperatorPropertiesKeys": { + "base": null, + "refs": { + "TaskPropertiesMap$key": null + } + }, + "Password": { + "base": null, + "refs": { + "RedshiftConnectorProfileCredentials$password": "The password that corresponds to the user name.
", + "ServiceNowConnectorProfileCredentials$password": "The password that corresponds to the user name.
", + "SnowflakeConnectorProfileCredentials$password": "The password that corresponds to the user name.
", + "VeevaConnectorProfileCredentials$password": "The password that corresponds to the user name.
" + } + }, + "PrefixConfig": { + "base": "Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date.
", + "refs": { + "S3OutputFormatConfig$prefixConfig": "Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date.
" + } + }, + "PrefixFormat": { + "base": null, + "refs": { + "PrefixConfig$prefixFormat": "Determines the format of the prefix, and whether it applies to the file name, file path, or both.
" + } + }, + "PrefixType": { + "base": null, + "refs": { + "PrefixConfig$prefixType": "Determines the level of granularity that's included in the prefix.
" + } + }, + "PrivateLinkServiceName": { + "base": null, + "refs": { + "SnowflakeConnectorProfileProperties$privateLinkServiceName": "The Snowflake Private Link service name to be used for private data transfers.
" + } + }, + "Property": { + "base": null, + "refs": { + "TaskPropertiesMap$value": null + } + }, + "RedirectUri": { + "base": null, + "refs": { + "ConnectorOAuthRequest$redirectUri": "The URL to which the authentication server redirects the browser after authorization has been granted.
" + } + }, + "RedshiftConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Amazon Redshift.
", + "refs": { + "ConnectorProfileCredentials$Redshift": "The connector-specific credentials required when using Amazon Redshift.
" + } + }, + "RedshiftConnectorProfileProperties": { + "base": "The connector-specific profile properties when using Amazon Redshift.
", + "refs": { + "ConnectorProfileProperties$Redshift": "The connector-specific properties required by Amazon Redshift.
" + } + }, + "RedshiftDestinationProperties": { + "base": "The properties that are applied when Amazon Redshift is being used as a destination.
", + "refs": { + "DestinationConnectorProperties$Redshift": "The properties required to query Amazon Redshift.
" + } + }, + "RedshiftMetadata": { + "base": "The connector metadata specific to Amazon Redshift.
", + "refs": { + "ConnectorMetadata$Redshift": "The connector metadata specific to Amazon Redshift.
" + } + }, + "RefreshToken": { + "base": null, + "refs": { + "GoogleAnalyticsConnectorProfileCredentials$refreshToken": "The credentials used to acquire new access tokens. This is required only for OAuth2 access tokens, and is not required for OAuth1 access tokens.
", + "SalesforceConnectorProfileCredentials$refreshToken": "The credentials used to acquire new access tokens.
" + } + }, + "Region": { + "base": null, + "refs": { + "RegionList$member": null, + "SnowflakeConnectorProfileProperties$region": "The AWS Region of the Snowflake account.
" + } + }, + "RegionList": { + "base": null, + "refs": { + "SnowflakeMetadata$supportedRegions": "Specifies the supported AWS Regions when using Snowflake.
" + } + }, + "ResourceNotFoundException": { + "base": "The resource specified in the request (such as the source or destination connector profile) is not found.
", + "refs": { + } + }, + "RoleArn": { + "base": null, + "refs": { + "RedshiftConnectorProfileProperties$roleArn": "The Amazon Resource Name (ARN) of the IAM role.
" + } + }, + "S3ConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$S3": "The operation to be performed on the provided Amazon S3 source fields.
" + } + }, + "S3DestinationProperties": { + "base": "The properties that are applied when Amazon S3 is used as a destination.
", + "refs": { + "DestinationConnectorProperties$S3": "The properties required to query Amazon S3.
" + } + }, + "S3Metadata": { + "base": "The connector metadata specific to Amazon S3.
", + "refs": { + "ConnectorMetadata$S3": "The connector metadata specific to Amazon S3.
" + } + }, + "S3OutputFormatConfig": { + "base": "The configuration that determines how Amazon AppFlow should format the flow output data when Amazon S3 is used as the destination.
", + "refs": { + "S3DestinationProperties$s3OutputFormatConfig": null + } + }, + "S3SourceProperties": { + "base": "The properties that are applied when Amazon S3 is being used as the flow source.
", + "refs": { + "SourceConnectorProperties$S3": "Specifies the information that is required for querying Amazon S3.
" + } + }, + "SalesforceConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Salesforce": "The operation to be performed on the provided Salesforce source fields.
" + } + }, + "SalesforceConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Salesforce.
", + "refs": { + "ConnectorProfileCredentials$Salesforce": "The connector-specific credentials required when using Salesforce.
" + } + }, + "SalesforceConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Salesforce.
", + "refs": { + "ConnectorProfileProperties$Salesforce": "The connector-specific properties required by Salesforce.
" + } + }, + "SalesforceDestinationProperties": { + "base": "The properties that are applied when Salesforce is being used as a destination.
", + "refs": { + "DestinationConnectorProperties$Salesforce": "The properties required to query Salesforce.
" + } + }, + "SalesforceMetadata": { + "base": "The connector metadata specific to Salesforce.
", + "refs": { + "ConnectorMetadata$Salesforce": "The connector metadata specific to Salesforce.
" + } + }, + "SalesforceSourceProperties": { + "base": "The properties that are applied when Salesforce is being used as a source.
", + "refs": { + "SourceConnectorProperties$Salesforce": "Specifies the information that is required for querying Salesforce.
" + } + }, + "ScheduleExpression": { + "base": null, + "refs": { + "ScheduledTriggerProperties$scheduleExpression": "The scheduling expression that determines when and how often the rule runs.
" + } + }, + "ScheduleFrequencyType": { + "base": null, + "refs": { + "SchedulingFrequencyTypeList$member": null + } + }, + "ScheduledTriggerProperties": { + "base": " Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow as defined by the user.
" + } + }, + "SchedulingFrequencyTypeList": { + "base": null, + "refs": { + "ConnectorConfiguration$supportedSchedulingFrequencies": "Specifies the supported flow frequency for that connector.
" + } + }, + "SecretKey": { + "base": null, + "refs": { + "AmplitudeConnectorProfileCredentials$secretKey": "The Secret Access Key portion of the credentials.
" + } + }, + "ServiceNowConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$ServiceNow": "The operation to be performed on the provided ServiceNow source fields.
" + } + }, + "ServiceNowConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using ServiceNow.
", + "refs": { + "ConnectorProfileCredentials$ServiceNow": "The connector-specific credentials required when using ServiceNow.
" + } + }, + "ServiceNowConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using ServiceNow.
", + "refs": { + "ConnectorProfileProperties$ServiceNow": "The connector-specific properties required by serviceNow.
" + } + }, + "ServiceNowMetadata": { + "base": "The connector metadata specific to ServiceNow.
", + "refs": { + "ConnectorMetadata$ServiceNow": "The connector metadata specific to ServiceNow.
" + } + }, + "ServiceNowSourceProperties": { + "base": "The properties that are applied when ServiceNow is being used as a source.
", + "refs": { + "SourceConnectorProperties$ServiceNow": "Specifies the information that is required for querying ServiceNow.
" + } + }, + "ServiceQuotaExceededException": { + "base": "The request would cause a service quota (such as the number of flows) to be exceeded.
", + "refs": { + } + }, + "SingularConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Singular": "The operation to be performed on the provided Singular source fields.
" + } + }, + "SingularConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Singular.
", + "refs": { + "ConnectorProfileCredentials$Singular": "The connector-specific credentials required when using Singular.
" + } + }, + "SingularConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Singular.
", + "refs": { + "ConnectorProfileProperties$Singular": "The connector-specific properties required by Singular.
" + } + }, + "SingularMetadata": { + "base": "The connector metadata specific to Singular.
", + "refs": { + "ConnectorMetadata$Singular": "The connector metadata specific to Singular.
" + } + }, + "SingularSourceProperties": { + "base": "The properties that are applied when Singular is being used as a source.
", + "refs": { + "SourceConnectorProperties$Singular": "Specifies the information that is required for querying Singular.
" + } + }, + "SlackConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Slack": "The operation to be performed on the provided Slack source fields.
" + } + }, + "SlackConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Slack.
", + "refs": { + "ConnectorProfileCredentials$Slack": "The connector-specific credentials required when using Slack.
" + } + }, + "SlackConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Slack.
", + "refs": { + "ConnectorProfileProperties$Slack": "The connector-specific properties required by Slack.
" + } + }, + "SlackMetadata": { + "base": "The connector metadata specific to Slack.
", + "refs": { + "ConnectorMetadata$Slack": "The connector metadata specific to Slack.
" + } + }, + "SlackSourceProperties": { + "base": "The properties that are applied when Slack is being used as a source.
", + "refs": { + "SourceConnectorProperties$Slack": "Specifies the information that is required for querying Slack.
" + } + }, + "SnowflakeConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Snowflake.
", + "refs": { + "ConnectorProfileCredentials$Snowflake": "The connector-specific credentials required when using Snowflake.
" + } + }, + "SnowflakeConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Snowflake.
", + "refs": { + "ConnectorProfileProperties$Snowflake": "The connector-specific properties required by Snowflake.
" + } + }, + "SnowflakeDestinationProperties": { + "base": "The properties that are applied when Snowflake is being used as a destination.
", + "refs": { + "DestinationConnectorProperties$Snowflake": "The properties required to query Snowflake.
" + } + }, + "SnowflakeMetadata": { + "base": "The connector metadata specific to Snowflake.
", + "refs": { + "ConnectorMetadata$Snowflake": "The connector metadata specific to Snowflake.
" + } + }, + "SourceConnectorProperties": { + "base": "Specifies the information that is required to query a particular connector.
", + "refs": { + "SourceFlowConfig$sourceConnectorProperties": "Specifies the information that is required to query a particular source connector.
" + } + }, + "SourceFieldProperties": { + "base": "The properties that can be applied to a field when the connector is being used as a source.
", + "refs": { + "ConnectorEntityField$sourceProperties": "The properties that can be applied to a field when the connector is being used as a source.
" + } + }, + "SourceFields": { + "base": null, + "refs": { + "Task$sourceFields": "The source fields to which a particular task is applied.
" + } + }, + "SourceFlowConfig": { + "base": "Contains information about the configuration of the source connector used in the flow.
", + "refs": { + "CreateFlowRequest$sourceFlowConfig": "The configuration that controls how Amazon AppFlow retrieves data from the source connector.
", + "DescribeFlowResponse$sourceFlowConfig": "The configuration that controls how Amazon AppFlow retrieves data from the source connector.
", + "UpdateFlowRequest$sourceFlowConfig": null + } + }, + "Stage": { + "base": null, + "refs": { + "SnowflakeConnectorProfileProperties$stage": "The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.
" + } + }, + "StartFlowRequest": { + "base": null, + "refs": { + } + }, + "StartFlowResponse": { + "base": null, + "refs": { + } + }, + "StopFlowRequest": { + "base": null, + "refs": { + } + }, + "StopFlowResponse": { + "base": null, + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "SourceFields$member": null + } + }, + "SupportedFieldTypeDetails": { + "base": " Contains details regarding all the supported FieldTypes and their corresponding filterOperators and supportedValues.
Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.
The list of values that a field can contain. For example, a Boolean fieldType can have two values: \"true\" and \"false\".
The tag keys associated with the tag that you want to remove from your flow.
" + } + }, + "TagMap": { + "base": null, + "refs": { + "CreateFlowRequest$tags": "The tags used to organize, track, or control access for your flow.
", + "DescribeFlowResponse$tags": "The tags used to organize, track, or control access for your flow.
", + "FlowDefinition$tags": "The tags used to organize, track, or control access for your flow.
", + "ListTagsForResourceResponse$tags": "The tags used to organize, track, or control access for your flow.
", + "TagResourceRequest$tags": "The tags used to organize, track, or control access for your flow.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "TagMap$value": null + } + }, + "Task": { + "base": " A class for modeling different type of tasks. Task implementation varies based on the TaskType.
A map used to store task-related information. The execution service looks for particular information based on the TaskType.
Specifies the particular task implementation that Amazon AppFlow performs.
" + } + }, + "Tasks": { + "base": null, + "refs": { + "CreateFlowRequest$tasks": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
", + "DescribeFlowResponse$tasks": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
", + "UpdateFlowRequest$tasks": "A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
" + } + }, + "Timezone": { + "base": null, + "refs": { + "ScheduledTriggerProperties$timezone": "Specifies the time zone used when referring to the date and time of a scheduled-triggered flow.
" + } + }, + "TrendmicroConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Trendmicro": "The operation to be performed on the provided Trend Micro source fields.
" + } + }, + "TrendmicroConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Trend Micro.
", + "refs": { + "ConnectorProfileCredentials$Trendmicro": "The connector-specific credentials required when using Trend Micro.
" + } + }, + "TrendmicroConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Trend Micro.
", + "refs": { + "ConnectorProfileProperties$Trendmicro": "The connector-specific properties required by Trend Micro.
" + } + }, + "TrendmicroMetadata": { + "base": "The connector metadata specific to Trend Micro.
", + "refs": { + "ConnectorMetadata$Trendmicro": "The connector metadata specific to Trend Micro.
" + } + }, + "TrendmicroSourceProperties": { + "base": "The properties that are applied when using Trend Micro as a flow source.
", + "refs": { + "SourceConnectorProperties$Trendmicro": "Specifies the information that is required for querying Trend Micro.
" + } + }, + "TriggerConfig": { + "base": "The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
", + "refs": { + "CreateFlowRequest$triggerConfig": "The trigger settings that determine how and when the flow runs.
", + "DescribeFlowResponse$triggerConfig": "The trigger settings that determine how and when the flow runs.
", + "UpdateFlowRequest$triggerConfig": "The trigger settings that determine how and when the flow runs.
" + } + }, + "TriggerProperties": { + "base": " Specifies the configuration details that control the trigger for a flow. Currently, these settings only apply to the Scheduled trigger type.
Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the Scheduled trigger type.
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
Specifies the type of flow trigger. This can be OnDemand, Scheduled, or Event.
Specifies the supported trigger types for the flow.
" + } + }, + "UnsupportedOperationException": { + "base": "The requested operation is not supported for the current flow.
", + "refs": { + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateConnectorProfileRequest": { + "base": null, + "refs": { + } + }, + "UpdateConnectorProfileResponse": { + "base": null, + "refs": { + } + }, + "UpdateFlowRequest": { + "base": null, + "refs": { + } + }, + "UpdateFlowResponse": { + "base": null, + "refs": { + } + }, + "UpdatedBy": { + "base": null, + "refs": { + "DescribeFlowResponse$lastUpdatedBy": "Specifies the user name of the account that performed the most recent update.
", + "FlowDefinition$lastUpdatedBy": "Specifies the account user name that most recently updated the flow.
" + } + }, + "Username": { + "base": null, + "refs": { + "InforNexusConnectorProfileCredentials$userId": "The identifier for the user.
", + "RedshiftConnectorProfileCredentials$username": "The name of the user.
", + "ServiceNowConnectorProfileCredentials$username": "The name of the user.
", + "SnowflakeConnectorProfileCredentials$username": "The name of the user.
", + "VeevaConnectorProfileCredentials$username": "The name of the user.
" + } + }, + "ValidationException": { + "base": "The request has invalid or missing parameters.
", + "refs": { + } + }, + "Value": { + "base": null, + "refs": { + "SupportedValueList$member": null + } + }, + "VeevaConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Veeva": "The operation to be performed on the provided Veeva source fields.
" + } + }, + "VeevaConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Veeva.
", + "refs": { + "ConnectorProfileCredentials$Veeva": "The connector-specific credentials required when using Veeva.
" + } + }, + "VeevaConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Veeva.
", + "refs": { + "ConnectorProfileProperties$Veeva": "The connector-specific properties required by Veeva.
" + } + }, + "VeevaMetadata": { + "base": "The connector metadata specific to Veeva.
", + "refs": { + "ConnectorMetadata$Veeva": "The connector metadata specific to Veeva.
" + } + }, + "VeevaSourceProperties": { + "base": "The properties that are applied when using Veeva as a flow source.
", + "refs": { + "SourceConnectorProperties$Veeva": "Specifies the information that is required for querying Veeva.
" + } + }, + "Warehouse": { + "base": null, + "refs": { + "SnowflakeConnectorProfileProperties$warehouse": "The name of the Snowflake warehouse.
" + } + }, + "ZendeskConnectorOperator": { + "base": null, + "refs": { + "ConnectorOperator$Zendesk": "The operation to be performed on the provided Zendesk source fields.
" + } + }, + "ZendeskConnectorProfileCredentials": { + "base": "The connector-specific profile credentials required when using Zendesk.
", + "refs": { + "ConnectorProfileCredentials$Zendesk": "The connector-specific credentials required when using Zendesk.
" + } + }, + "ZendeskConnectorProfileProperties": { + "base": "The connector-specific profile properties required when using Zendesk.
", + "refs": { + "ConnectorProfileProperties$Zendesk": "The connector-specific properties required by Zendesk.
" + } + }, + "ZendeskMetadata": { + "base": "The connector metadata specific to Zendesk.
", + "refs": { + "ConnectorMetadata$Zendesk": "The connector metadata specific to Zendesk.
" + } + }, + "ZendeskSourceProperties": { + "base": "The properties that are applied when using Zendesk as a flow source.
", + "refs": { + "SourceConnectorProperties$Zendesk": "Specifies the information that is required for querying Zendesk.
" + } + } + } +} diff --git a/aws-sdk-core/apis/appflow/2020-08-23/examples-1.json b/aws-sdk-core/apis/appflow/2020-08-23/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/aws-sdk-core/apis/appflow/2020-08-23/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws-sdk-core/apis/appflow/2020-08-23/paginators-1.json b/aws-sdk-core/apis/appflow/2020-08-23/paginators-1.json new file mode 100644 index 00000000000..deabfa47b56 --- /dev/null +++ b/aws-sdk-core/apis/appflow/2020-08-23/paginators-1.json @@ -0,0 +1,23 @@ +{ + "pagination": { + "DescribeConnectorProfiles": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "DescribeConnectors": { + "input_token": "nextToken", + "output_token": "nextToken" + }, + "DescribeFlowExecutionRecords": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListFlows": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/aws-sdk-core/apis/route53resolver/2018-04-01/api-2.json b/aws-sdk-core/apis/route53resolver/2018-04-01/api-2.json index c75fa58237d..d4b360e4da6 100644 --- a/aws-sdk-core/apis/route53resolver/2018-04-01/api-2.json +++ b/aws-sdk-core/apis/route53resolver/2018-04-01/api-2.json @@ -31,6 +31,25 @@ {"shape":"ThrottlingException"} ] }, + "AssociateResolverQueryLogConfig":{ + "name":"AssociateResolverQueryLogConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateResolverQueryLogConfigRequest"}, + "output":{"shape":"AssociateResolverQueryLogConfigResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "AssociateResolverRule":{ "name":"AssociateResolverRule", "http":{ @@ -42,6 +61,7 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, {"shape":"InvalidParameterException"}, {"shape":"ResourceUnavailableException"}, {"shape":"ResourceExistsException"}, @@ -67,6 +87,25 @@ {"shape":"ThrottlingException"} ] }, + "CreateResolverQueryLogConfig":{ + "name":"CreateResolverQueryLogConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResolverQueryLogConfigRequest"}, + "output":{"shape":"CreateResolverQueryLogConfigResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "CreateResolverRule":{ "name":"CreateResolverRule", "http":{ @@ -102,6 +141,23 @@ {"shape":"ThrottlingException"} ] }, + "DeleteResolverQueryLogConfig":{ + "name":"DeleteResolverQueryLogConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResolverQueryLogConfigRequest"}, + "output":{"shape":"DeleteResolverQueryLogConfigResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "DeleteResolverRule":{ "name":"DeleteResolverRule", "http":{ @@ -135,6 +191,23 @@ {"shape":"ThrottlingException"} ] }, + "DisassociateResolverQueryLogConfig":{ + "name":"DisassociateResolverQueryLogConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateResolverQueryLogConfigRequest"}, + "output":{"shape":"DisassociateResolverQueryLogConfigResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "DisassociateResolverRule":{ "name":"DisassociateResolverRule", "http":{ @@ -165,6 +238,56 @@ {"shape":"ThrottlingException"} ] }, + "GetResolverQueryLogConfig":{ + "name":"GetResolverQueryLogConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverQueryLogConfigRequest"}, + "output":{"shape":"GetResolverQueryLogConfigResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "GetResolverQueryLogConfigAssociation":{ + "name":"GetResolverQueryLogConfigAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverQueryLogConfigAssociationRequest"}, + "output":{"shape":"GetResolverQueryLogConfigAssociationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "GetResolverQueryLogConfigPolicy":{ + "name":"GetResolverQueryLogConfigPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverQueryLogConfigPolicyRequest"}, + "output":{"shape":"GetResolverQueryLogConfigPolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"AccessDeniedException"} + ] + }, "GetResolverRule":{ "name":"GetResolverRule", "http":{ @@ -241,6 +364,40 @@ {"shape":"ThrottlingException"} ] }, + "ListResolverQueryLogConfigAssociations":{ + "name":"ListResolverQueryLogConfigAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverQueryLogConfigAssociationsRequest"}, + "output":{"shape":"ListResolverQueryLogConfigAssociationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListResolverQueryLogConfigs":{ + "name":"ListResolverQueryLogConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverQueryLogConfigsRequest"}, + "output":{"shape":"ListResolverQueryLogConfigsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, "ListResolverRuleAssociations":{ "name":"ListResolverRuleAssociations", "http":{ @@ -290,6 +447,23 @@ {"shape":"ThrottlingException"} ] }, + "PutResolverQueryLogConfigPolicy":{ + "name":"PutResolverQueryLogConfigPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResolverQueryLogConfigPolicyRequest"}, + "output":{"shape":"PutResolverQueryLogConfigPolicyResponse"}, + "errors":[ + {"shape":"InvalidPolicyDocument"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"AccessDeniedException"} + ] + }, "PutResolverRulePolicy":{ "name":"PutResolverRulePolicy", "http":{ @@ -317,6 +491,7 @@ {"shape":"LimitExceededException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, {"shape":"InvalidTagException"}, {"shape":"InternalServiceErrorException"}, {"shape":"ThrottlingException"} @@ -333,6 +508,7 @@ "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, {"shape":"InternalServiceErrorException"}, {"shape":"ThrottlingException"} ] @@ -373,6 +549,13 @@ } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "exception":true + }, "AccountId":{ "type":"string", "max":32, @@ -400,6 +583,23 @@ "ResolverEndpoint":{"shape":"ResolverEndpoint"} } }, + "AssociateResolverQueryLogConfigRequest":{ + "type":"structure", + "required":[ + "ResolverQueryLogConfigId", + "ResourceId" + ], + "members":{ + "ResolverQueryLogConfigId":{"shape":"ResourceId"}, + "ResourceId":{"shape":"ResourceId"} + } + }, + "AssociateResolverQueryLogConfigResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfigAssociation":{"shape":"ResolverQueryLogConfigAssociation"} + } + }, "AssociateResolverRuleRequest":{ "type":"structure", "required":[ @@ -419,6 +619,7 @@ } }, "Boolean":{"type":"boolean"}, + "Count":{"type":"integer"}, "CreateResolverEndpointRequest":{ "type":"structure", "required":[ @@ -448,6 +649,32 @@ "ResolverEndpoint":{"shape":"ResolverEndpoint"} } }, + "CreateResolverQueryLogConfigRequest":{ + "type":"structure", + "required":[ + "Name", + "DestinationArn", + "CreatorRequestId" + ], + "members":{ + "Name":{"shape":"ResolverQueryLogConfigName"}, + "DestinationArn":{"shape":"DestinationArn"}, + "CreatorRequestId":{ + "shape":"CreatorRequestId", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "box":true + } + } + }, + "CreateResolverQueryLogConfigResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfig":{"shape":"ResolverQueryLogConfig"} + } + }, "CreateResolverRuleRequest":{ "type":"structure", "required":[ @@ -498,6 +725,19 @@ "ResolverEndpoint":{"shape":"ResolverEndpoint"} } }, + "DeleteResolverQueryLogConfigRequest":{ + "type":"structure", + "required":["ResolverQueryLogConfigId"], + "members":{ + "ResolverQueryLogConfigId":{"shape":"ResourceId"} + } + }, + "DeleteResolverQueryLogConfigResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfig":{"shape":"ResolverQueryLogConfig"} + } + }, "DeleteResolverRuleRequest":{ "type":"structure", "required":["ResolverRuleId"], @@ -511,6 +751,11 @@ "ResolverRule":{"shape":"ResolverRule"} } }, + "DestinationArn":{ + "type":"string", + "max":600, + "min":1 + }, "DisassociateResolverEndpointIpAddressRequest":{ "type":"structure", "required":[ @@ -528,6 +773,23 @@ "ResolverEndpoint":{"shape":"ResolverEndpoint"} } }, + "DisassociateResolverQueryLogConfigRequest":{ + "type":"structure", + "required":[ + "ResolverQueryLogConfigId", + "ResourceId" + ], + "members":{ + "ResolverQueryLogConfigId":{"shape":"ResourceId"}, + "ResourceId":{"shape":"ResourceId"} + } + }, + "DisassociateResolverQueryLogConfigResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfigAssociation":{"shape":"ResolverQueryLogConfigAssociation"} + } + }, "DisassociateResolverRuleRequest":{ "type":"structure", "required":[ @@ -565,7 +827,7 @@ }, "FilterValue":{ "type":"string", - "max":64, + "max":600, "min":1 }, "FilterValues":{ @@ -589,6 +851,45 @@ "ResolverEndpoint":{"shape":"ResolverEndpoint"} } }, + "GetResolverQueryLogConfigAssociationRequest":{ + "type":"structure", + "required":["ResolverQueryLogConfigAssociationId"], + "members":{ + "ResolverQueryLogConfigAssociationId":{"shape":"ResourceId"} + } + }, + "GetResolverQueryLogConfigAssociationResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfigAssociation":{"shape":"ResolverQueryLogConfigAssociation"} + } + }, + "GetResolverQueryLogConfigPolicyRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{"shape":"Arn"} + } + }, + "GetResolverQueryLogConfigPolicyResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfigPolicy":{"shape":"ResolverQueryLogConfigPolicy"} + } + }, + "GetResolverQueryLogConfigRequest":{ + "type":"structure", + "required":["ResolverQueryLogConfigId"], + "members":{ + "ResolverQueryLogConfigId":{"shape":"ResourceId"} + } + }, + "GetResolverQueryLogConfigResponse":{ + "type":"structure", + "members":{ + "ResolverQueryLogConfig":{"shape":"ResolverQueryLogConfig"} + } + }, "GetResolverRuleAssociationRequest":{ "type":"structure", "required":["ResolverRuleAssociationId"], @@ -799,6 +1100,53 @@ "ResolverEndpoints":{"shape":"ResolverEndpoints"} } }, + "ListResolverQueryLogConfigAssociationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"NextToken"}, + "Filters":{"shape":"Filters"}, + "SortBy":{"shape":"SortByKey"}, + "SortOrder":{"shape":"SortOrder"} + } + }, + "ListResolverQueryLogConfigAssociationsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "TotalCount":{"shape":"Count"}, + "TotalFilteredCount":{"shape":"Count"}, + "ResolverQueryLogConfigAssociations":{"shape":"ResolverQueryLogConfigAssociationList"} + } + }, + "ListResolverQueryLogConfigsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "box":true + }, + "Filters":{ + "shape":"Filters", + "box":true + }, + "SortBy":{"shape":"SortByKey"}, + "SortOrder":{"shape":"SortOrder"} + } + }, + "ListResolverQueryLogConfigsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "TotalCount":{"shape":"Count"}, + "TotalFilteredCount":{"shape":"Count"}, + "ResolverQueryLogConfigs":{"shape":"ResolverQueryLogConfigList"} + } + }, "ListResolverRuleAssociationsRequest":{ "type":"structure", "members":{ @@ -879,7 +1227,7 @@ "Name":{ "type":"string", "max":64, - "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)" + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)" }, "NextToken":{"type":"string"}, "Port":{ @@ -887,6 +1235,23 @@ "max":65535, "min":0 }, + "PutResolverQueryLogConfigPolicyRequest":{ + "type":"structure", + "required":[ + "Arn", + "ResolverQueryLogConfigPolicy" + ], + "members":{ + "Arn":{"shape":"Arn"}, + "ResolverQueryLogConfigPolicy":{"shape":"ResolverQueryLogConfigPolicy"} + } + }, + "PutResolverQueryLogConfigPolicyResponse":{ + "type":"structure", + "members":{ + "ReturnValue":{"shape":"Boolean"} + } + }, "PutResolverRulePolicyRequest":{ "type":"structure", "required":[ @@ -943,6 +1308,80 @@ "type":"list", "member":{"shape":"ResolverEndpoint"} }, + "ResolverQueryLogConfig":{ + "type":"structure", + "members":{ + "Id":{"shape":"ResourceId"}, + "OwnerId":{"shape":"AccountId"}, + "Status":{"shape":"ResolverQueryLogConfigStatus"}, + "ShareStatus":{"shape":"ShareStatus"}, + "AssociationCount":{"shape":"Count"}, + "Arn":{"shape":"Arn"}, + "Name":{"shape":"ResolverQueryLogConfigName"}, + "DestinationArn":{"shape":"DestinationArn"}, + "CreatorRequestId":{"shape":"CreatorRequestId"}, + "CreationTime":{"shape":"Rfc3339TimeString"} + } + }, + "ResolverQueryLogConfigAssociation":{ + "type":"structure", + "members":{ + "Id":{"shape":"ResourceId"}, + "ResolverQueryLogConfigId":{"shape":"ResourceId"}, + "ResourceId":{"shape":"ResourceId"}, + "Status":{"shape":"ResolverQueryLogConfigAssociationStatus"}, + "Error":{"shape":"ResolverQueryLogConfigAssociationError"}, + "ErrorMessage":{"shape":"ResolverQueryLogConfigAssociationErrorMessage"}, + "CreationTime":{"shape":"Rfc3339TimeString"} + } + }, + "ResolverQueryLogConfigAssociationError":{ + "type":"string", + "enum":[ + "NONE", + "DESTINATION_NOT_FOUND", + "ACCESS_DENIED", + "INTERNAL_SERVICE_ERROR" + ] + }, + "ResolverQueryLogConfigAssociationErrorMessage":{"type":"string"}, + "ResolverQueryLogConfigAssociationList":{ + "type":"list", + "member":{"shape":"ResolverQueryLogConfigAssociation"} + }, + "ResolverQueryLogConfigAssociationStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "ACTION_NEEDED", + "DELETING", + "FAILED" + ] + }, + "ResolverQueryLogConfigList":{ + "type":"list", + "member":{"shape":"ResolverQueryLogConfig"} + }, + "ResolverQueryLogConfigName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)" + }, + "ResolverQueryLogConfigPolicy":{ + "type":"string", + "max":5000 + }, + "ResolverQueryLogConfigStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "DELETING", + "FAILED" + ] + }, "ResolverRule":{ "type":"structure", "members":{ @@ -957,7 +1396,9 @@ "TargetIps":{"shape":"TargetList"}, "ResolverEndpointId":{"shape":"ResourceId"}, "OwnerId":{"shape":"AccountId"}, - "ShareStatus":{"shape":"ShareStatus"} + "ShareStatus":{"shape":"ShareStatus"}, + "CreationTime":{"shape":"Rfc3339TimeString"}, + "ModificationTime":{"shape":"Rfc3339TimeString"} } }, "ResolverRuleAssociation":{ @@ -1072,6 +1513,18 @@ "SHARED_BY_ME" ] }, + "SortByKey":{ + "type":"string", + "max":64, + "min":1 + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, "StatusMessage":{ "type":"string", "max":255 @@ -1084,19 +1537,29 @@ }, "Tag":{ "type":"structure", + "required":[ + "Key", + "Value" + ], "members":{ "Key":{"shape":"TagKey"}, "Value":{"shape":"TagValue"} } }, - "TagKey":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, "TagKeyList":{ "type":"list", - "member":{"shape":"TagKey"} + "member":{"shape":"TagKey"}, + "max":200 }, "TagList":{ "type":"list", - "member":{"shape":"Tag"} + "member":{"shape":"Tag"}, + "max":200 }, "TagResourceRequest":{ "type":"structure", @@ -1114,7 +1577,11 @@ "members":{ } }, - "TagValue":{"type":"string"}, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, "TargetAddress":{ "type":"structure", "required":["Ip"], diff --git a/aws-sdk-core/apis/route53resolver/2018-04-01/docs-2.json b/aws-sdk-core/apis/route53resolver/2018-04-01/docs-2.json index ce0e8d1b2c5..a9ae43bb32d 100644 --- a/aws-sdk-core/apis/route53resolver/2018-04-01/docs-2.json +++ b/aws-sdk-core/apis/route53resolver/2018-04-01/docs-2.json @@ -1,47 +1,66 @@ { "version": "2.0", - "service": "Here's how you set up to query an Amazon Route 53 private hosted zone from your network:
Connect your network to a VPC using AWS Direct Connect or a VPN.
Run the following AWS CLI command to create a Resolver endpoint:
create-resolver-endpoint --name [endpoint_name] --direction INBOUND --creator-request-id [unique_string] --security-group-ids [security_group_with_inbound_rules] --ip-addresses SubnetId=[subnet_id] SubnetId=[subnet_id_in_different_AZ]
Note the resolver endpoint ID that appears in the response. You'll use it in step 3.
Get the IP addresses for the Resolver endpoints:
get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]
In your network configuration, define the IP addresses that you got in step 3 as DNS servers.
You can now query instance names in your VPCs and the names of records in your private hosted zone.
You can also perform the following operations using the AWS CLI:
list-resolver-endpoints: List all endpoints. The syntax includes options for pagination and filtering.
update-resolver-endpoints: Add IP addresses to an endpoint or remove IP addresses from an endpoint.
To delete an endpoint, use the following AWS CLI command:
delete-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]
When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or ELB load balancers. Resolver performs recursive lookups against public name servers for all other domain names.
You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:
Forward DNS queries from resolvers on your network to Route 53 Resolver
DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for AWS resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver in the Amazon Route 53 Developer Guide.
Conditionally forward queries from a VPC to resolvers on your network
You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network in the Amazon Route 53 Developer Guide.
Like Amazon VPC, Resolver is regional. In each region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.
", "operations": { - "AssociateResolverEndpointIpAddress": "Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
", - "AssociateResolverRule": "Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.
", - "CreateResolverEndpoint": "Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:
An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC.
An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.
For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
", - "DeleteResolverEndpoint": "Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint:
Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.
Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.
", - "DisassociateResolverEndpointIpAddress": "Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.
To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
", - "DisassociateResolverRule": "Removes the association between a specified resolver rule and a specified VPC.
If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.
Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.
", - "GetResolverRule": "Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.
", - "GetResolverRuleAssociation": "Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.
", - "GetResolverRulePolicy": "Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
", - "ListResolverEndpointIpAddresses": "Gets the IP addresses for a specified resolver endpoint.
", - "ListResolverEndpoints": "Lists all the resolver endpoints that were created using the current AWS account.
", - "ListResolverRuleAssociations": "Lists the associations that were created between resolver rules and VPCs using the current AWS account.
", - "ListResolverRules": "Lists the resolver rules that were created using the current AWS account.
", + "AssociateResolverEndpointIpAddress": "Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.
", + "AssociateResolverQueryLogConfig": "Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one AssociateResolverQueryLogConfig request for each VPC.
The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.
To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.
", + "AssociateResolverRule": "Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.
", + "CreateResolverEndpoint": "Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:
An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.
Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.
To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.
You can optionally use AWS Resource Access Manager (AWS RAM) to share a query logging configuration with other AWS accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.
", + "CreateResolverRule": "For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.
", + "DeleteResolverEndpoint": "Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:
Inbound: DNS queries from your network are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network.
Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other AWS accounts, and the other accounts have associated VPCs with the shared configuration.
Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.
If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.
", + "DeleteResolverRule": "Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see DisassociateResolverRule.
", + "DisassociateResolverEndpointIpAddress": "Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.
To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.
", + "DisassociateResolverQueryLogConfig": "Disassociates a VPC from a query logging configuration.
Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:
The accounts that you shared the configuration with can disassociate VPCs from the configuration.
You can stop sharing the configuration.
Removes the association between a specified Resolver rule and a specified VPC.
If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule.
Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.
", + "GetResolverQueryLogConfig": "Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to.
", + "GetResolverQueryLogConfigAssociation": "Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.
", + "GetResolverQueryLogConfigPolicy": "Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another AWS account to be able to use.
", + "GetResolverRule": "Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.
", + "GetResolverRuleAssociation": "Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule.
", + "GetResolverRulePolicy": "Gets information about a Resolver rule policy. A Resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
", + "ListResolverEndpointIpAddresses": "Gets the IP addresses for a specified Resolver endpoint.
", + "ListResolverEndpoints": "Lists all the Resolver endpoints that were created using the current AWS account.
", + "ListResolverQueryLogConfigAssociations": "Lists information about associations between Amazon VPCs and query logging configurations.
", + "ListResolverQueryLogConfigs": "Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.
", + "ListResolverRuleAssociations": "Lists the associations that were created between Resolver rules and VPCs using the current AWS account.
", + "ListResolverRules": "Lists the Resolver rules that were created using the current AWS account.
", "ListTagsForResource": "Lists the tags that you associated with the specified resource.
", - "PutResolverRulePolicy": "Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.
", + "PutResolverQueryLogConfigPolicy": "Specifies an AWS account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.
", + "PutResolverRulePolicy": "Specifies an AWS account that you want to share rules with, the Resolver rules that you want to share, and the operations that you want the account to be able to perform on those rules.
", "TagResource": "Adds one or more tags to a specified resource.
", "UntagResource": "Removes one or more tags from a specified resource.
", - "UpdateResolverEndpoint": "Updates the name of an inbound or an outbound resolver endpoint.
", - "UpdateResolverRule": "Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
Updates the name of an inbound or an outbound Resolver endpoint.
", + "UpdateResolverRule": "Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
The current account doesn't have the IAM permissions required to perform the specified Resolver operation.
", + "refs": { + } + }, "AccountId": { "base": null, "refs": { + "ResolverQueryLogConfig$OwnerId": "The AWS account ID for the account that created the query logging configuration.
", "ResolverRule$OwnerId": "When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.
" } }, "Arn": { "base": null, "refs": { - "GetResolverRulePolicyRequest$Arn": "The ID of the resolver rule policy that you want to get information about.
", + "GetResolverQueryLogConfigPolicyRequest$Arn": "The ARN of the query logging configuration that you want to get the query logging policy for.
", + "GetResolverRulePolicyRequest$Arn": "The ID of the Resolver rule policy that you want to get information about.
", "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) for the resource that you want to list tags for.
", - "PutResolverRulePolicyRequest$Arn": "The Amazon Resource Name (ARN) of the account that you want to grant permissions to.
", - "ResolverEndpoint$Arn": "The ARN (Amazon Resource Name) for the resolver endpoint.
", - "ResolverRule$Arn": "The ARN (Amazon Resource Name) for the resolver rule specified by Id.
The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:
The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:
The Amazon Resource Name (ARN) of the account that you want to share rules with.
", + "PutResolverRulePolicyRequest$Arn": "The Amazon Resource Name (ARN) of the account that you want to share rules with.
", + "ResolverEndpoint$Arn": "The ARN (Amazon Resource Name) for the Resolver endpoint.
", + "ResolverQueryLogConfig$Arn": "The ARN for the query logging configuration.
", + "ResolverRule$Arn": "The ARN (Amazon Resource Name) for the Resolver rule specified by Id.
The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:
The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:
Whether the PutResolverQueryLogConfigPolicy request was successful.
Whether the PutResolverRulePolicy request was successful.
The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.
The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.
The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.
The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.
The number of VPCs that are associated with the query logging configuration.
" + } + }, "CreateResolverEndpointRequest": { "base": null, "refs": { @@ -80,6 +120,16 @@ "refs": { } }, + "CreateResolverQueryLogConfigRequest": { + "base": null, + "refs": { + } + }, + "CreateResolverQueryLogConfigResponse": { + "base": null, + "refs": { + } + }, "CreateResolverRuleRequest": { "base": null, "refs": { @@ -94,9 +144,11 @@ "base": null, "refs": { "CreateResolverEndpointRequest$CreatorRequestId": "A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.
A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.
A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.
A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.
A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.
A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of executing the operation twice.
The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:
S3 bucket:
arn:aws:s3:::examplebucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
" + } + }, "DisassociateResolverEndpointIpAddressRequest": { "base": null, "refs": { @@ -129,6 +198,16 @@ "refs": { } }, + "DisassociateResolverQueryLogConfigRequest": { + "base": null, + "refs": { + } + }, + "DisassociateResolverQueryLogConfigResponse": { + "base": null, + "refs": { + } + }, "DisassociateResolverRuleRequest": { "base": null, "refs": { @@ -142,13 +221,14 @@ "DomainName": { "base": null, "refs": { - "CreateResolverRuleRequest$DomainName": "DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com).
DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com).
DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).
DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).
For List operations, an optional specification to return a subset of objects, such as resolver endpoints or resolver rules.
For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, and ListResolverQueryLogConfigAssociations), an optional specification to return a subset of objects.
To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.
The name of the parameter that you want to use to filter objects.
The valid values for Name depend on the action that you're including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.
In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.
ListResolverEndpoints
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.
HostVpcId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.
ListResolverRules
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver rule.
DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the \".\" after com:
example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.
You can filter on the Resolver endpoint only for rules that have a value of FORWARD for RuleType.
Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.
ListResolverRuleAssociations
Valid values for Name include the following:
Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for Name include the following:
Arn: The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId: A unique string that identifies the request that created the query logging configuration.
Destination: The AWS service that you want to forward query logs to. Valid values include the following:
S3
CloudWatchLogs
KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The AWS account ID for the account that created the query logging configuration.
ShareStatus: An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Valid values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
ListResolverQueryLogConfigAssociations
Valid values for Name include the following:
CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.
When you're using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints.
If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID.
If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint.
If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.
If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of query logging associations.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of query logging configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.
If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.
If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
The specified resolver rule policy is invalid.
", + "base": "The specified Resolver rule policy is invalid.
", "refs": { } }, @@ -264,7 +376,7 @@ "base": null, "refs": { "IpAddressRequest$Ip": "The IP address that you want to use for DNS queries.
", - "IpAddressResponse$Ip": "One IP address that the resolver endpoint uses for DNS queries.
", + "IpAddressResponse$Ip": "One IP address that the Resolver endpoint uses for DNS queries.
", "IpAddressUpdate$Ip": "The new IP address.
", "TargetAddress$Ip": "One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.
" } @@ -272,17 +384,17 @@ "IpAddressCount": { "base": null, "refs": { - "ResolverEndpoint$IpAddressCount": "The number of IP addresses that the resolver endpoint can use for DNS queries.
" + "ResolverEndpoint$IpAddressCount": "The number of IP addresses that the Resolver endpoint can use for DNS queries.
" } }, "IpAddressRequest": { - "base": "In an CreateResolverEndpoint request, a subnet and IP address that you want to use for DNS queries.
", + "base": "In a CreateResolverEndpoint request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). IpAddressRequest also includes the ID of the subnet that contains the IP address.
In the response to a GetResolverEndpoint request, information about the IP addresses that the resolver endpoint uses for DNS queries.
", + "base": "In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.
", "refs": { "IpAddressesResponse$member": null } @@ -294,22 +406,22 @@ } }, "IpAddressUpdate": { - "base": "In an UpdateResolverEndpoint request, information about an IP address to update.
", + "base": "In an UpdateResolverEndpoint request, information about an IP address to update.
", "refs": { - "AssociateResolverEndpointIpAddressRequest$IpAddress": "Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.
", - "DisassociateResolverEndpointIpAddressRequest$IpAddress": "The IPv4 address that you want to remove from a resolver endpoint.
" + "AssociateResolverEndpointIpAddressRequest$IpAddress": "Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.
", + "DisassociateResolverEndpointIpAddressRequest$IpAddress": "The IPv4 address that you want to remove from a Resolver endpoint.
" } }, "IpAddressesRequest": { "base": null, "refs": { - "CreateResolverEndpointRequest$IpAddresses": "The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).
" + "CreateResolverEndpointRequest$IpAddresses": "The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC.
" } }, "IpAddressesResponse": { "base": null, "refs": { - "ListResolverEndpointIpAddressesResponse$IpAddresses": "The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint).
" + "ListResolverEndpointIpAddressesResponse$IpAddresses": "Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).
" } }, "LimitExceededException": { @@ -337,6 +449,26 @@ "refs": { } }, + "ListResolverQueryLogConfigAssociationsRequest": { + "base": null, + "refs": { + } + }, + "ListResolverQueryLogConfigAssociationsResponse": { + "base": null, + "refs": { + } + }, + "ListResolverQueryLogConfigsRequest": { + "base": null, + "refs": { + } + }, + "ListResolverQueryLogConfigsResponse": { + "base": null, + "refs": { + } + }, "ListResolverRuleAssociationsRequest": { "base": null, "refs": { @@ -372,11 +504,13 @@ "refs": { "ListResolverEndpointIpAddressesRequest$MaxResults": "The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.
The value that you specified for MaxResults in the request.
The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints.
The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.
The value that you specified for MaxResults in the request.
The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging associations.
The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.
The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.
The value that you specified for MaxResults in the request.
The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules.
The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver rules.
The value that you specified for MaxResults in the request.
The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.
A name for the association that you're creating between a resolver rule and a VPC.
", + "AssociateResolverRuleRequest$Name": "A name for the association that you're creating between a Resolver rule and a VPC.
", "CreateResolverEndpointRequest$Name": "A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
", "CreateResolverRuleRequest$Name": "A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
", - "ResolverEndpoint$Name": "The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.
", - "ResolverRule$Name": "The name for the resolver rule, which you specified when you created the resolver rule.
", - "ResolverRuleAssociation$Name": "The name of an association between a resolver rule and a VPC.
", - "ResolverRuleConfig$Name": "The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.
", - "UpdateResolverEndpointRequest$Name": "The name of the resolver endpoint that you want to update.
" + "ResolverEndpoint$Name": "The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
", + "ResolverRule$Name": "The name for the Resolver rule, which you specified when you created the Resolver rule.
", + "ResolverRuleAssociation$Name": "The name of an association between a Resolver rule and a VPC.
", + "ResolverRuleConfig$Name": "The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.
", + "UpdateResolverEndpointRequest$Name": "The name of the Resolver endpoint that you want to update.
" } }, "NextToken": { "base": null, "refs": { - "ListResolverEndpointIpAddressesRequest$NextToken": "For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverEndpoints request, omit this value.
If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverEndpoints request, omit this value.
If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.
If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverQueryLogConfigAssociations request, omit this value.
If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.
If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverQueryLogConfigs request, omit this value.
If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.
If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverRuleAssociation request, omit this value.
If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.
If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverRules request, omit this value.
If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.
If more than MaxResults resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
For the first ListResolverRules request, omit this value.
If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.
If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
For the first ListTagsForResource request, omit this value.
If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.
If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.
The port at Ip that you want to forward DNS queries to.
The response to a PutResolverQueryLogConfigPolicy request.
In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, ListResolverEndpoints, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound resolver endpoint.
", + "base": "In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, ListResolverEndpoints, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.
", "refs": { "AssociateResolverEndpointIpAddressResponse$ResolverEndpoint": "The response to an AssociateResolverEndpointIpAddress request.
Information about the CreateResolverEndpoint request, including the status of the request.
Information about the DeleteResolverEndpoint request, including the status of the request.
The response to an DisassociateResolverEndpointIpAddress request.
Information about the resolver endpoint that you specified in a GetResolverEndpoint request.
Information about the Resolver endpoint that you specified in a GetResolverEndpoint request.
The response to an UpdateResolverEndpoint request.
Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC
Indicates whether the resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network or another VPC
OUTBOUND: allows DNS queries from your VPC to your network or another VPC
Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network
Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
A code that specifies the current status of the resolver endpoint.
" + "ResolverEndpoint$Status": "A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn't be created for some reason that's outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.
" + "ListResolverEndpointsResponse$ResolverEndpoints": "The Resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.
" + } + }, + "ResolverQueryLogConfig": { + "base": "In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.
", + "refs": { + "CreateResolverQueryLogConfigResponse$ResolverQueryLogConfig": "Information about the CreateResolverQueryLogConfig request, including the status of the request.
Information about the query logging configuration that you deleted, including the status of the request.
", + "GetResolverQueryLogConfigResponse$ResolverQueryLogConfig": "Information about the Resolver query logging configuration that you specified in a GetQueryLogConfig request.
In the response to an AssociateResolverQueryLogConfig, DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
", + "refs": { + "AssociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation": "A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
", + "DisassociateResolverQueryLogConfigResponse$ResolverQueryLogConfigAssociation": "A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.
", + "GetResolverQueryLogConfigAssociationResponse$ResolverQueryLogConfigAssociation": "Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.
If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If the value of Status is a value other than FAILED, Error is null.
Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.
A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.
The status of the specified query logging association. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn't create or couldn't delete the query logging association.
A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.
The name that you want to give the query logging configuration
", + "ResolverQueryLogConfig$Name": "The name of the query logging configuration.
" + } + }, + "ResolverQueryLogConfigPolicy": { + "base": null, + "refs": { + "GetResolverQueryLogConfigPolicyResponse$ResolverQueryLogConfigPolicy": "Information about the query logging policy for the query logging configuration that you specified in a GetResolverQueryLogConfigPolicy request.
An AWS Identity and Access Management policy statement that lists the query logging configurations that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:
route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigAssociations
route53resolver:ListResolverQueryLogConfigs
In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.
The status of the specified query logging configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver can't deliver logs to the location that is specified in the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
For queries that originate in your VPC, detailed information about a resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.
For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.
Information about the CreateResolverRule request, including the status of the request.
Information about the DeleteResolverRule request, including the status of the request.
Information about the resolver rule that you specified in a GetResolverRule request.
Information about the Resolver rule that you specified in a GetResolverRule request.
The response to an UpdateResolverRule request.
In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, information about an association between a resolver rule and a VPC.
", + "base": "In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network.
", "refs": { "AssociateResolverRuleResponse$ResolverRuleAssociation": "Information about the AssociateResolverRule request, including the status of the request.
Information about the DisassociateResolverRule request, including the status of the request.
Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.
Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.
A code that specifies the current status of the association between a resolver rule and a VPC.
" + "ResolverRuleAssociation$Status": "A code that specifies the current status of the association between a Resolver rule and a VPC.
" } }, "ResolverRuleAssociations": { "base": null, "refs": { - "ListResolverRuleAssociationsResponse$ResolverRuleAssociations": "The associations that were created between resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.
" + "ListResolverRuleAssociationsResponse$ResolverRuleAssociations": "The associations that were created between Resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.
" } }, "ResolverRuleConfig": { - "base": "In an UpdateResolverRule request, information about the changes that you want to make.
", + "base": "In an UpdateResolverRule request, information about the changes that you want to make.
", "refs": { - "UpdateResolverRuleRequest$Config": "The new settings for the resolver rule.
" + "UpdateResolverRuleRequest$Config": "The new settings for the Resolver rule.
" } }, "ResolverRulePolicy": { "base": null, "refs": { - "GetResolverRulePolicyResponse$ResolverRulePolicy": "Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.
An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.
" + "GetResolverRulePolicyResponse$ResolverRulePolicy": "Information about the Resolver rule policy that you specified in a GetResolverRulePolicy request.
An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:
route53resolver:GetResolverRule
route53resolver:AssociateResolverRule
route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules
route53resolver:ListResolverRuleAssociations
In the Resource section of the statement, you specify the ARNs for the rules that you want to share with the account that you specified in Arn.
A code that specifies the current status of the resolver rule.
" + "ResolverRule$Status": "A code that specifies the current status of the Resolver rule.
" } }, "ResolverRules": { "base": null, "refs": { - "ListResolverRulesResponse$ResolverRules": "The resolver rules that were created using the current AWS account and that match the specified filters, if any.
" + "ListResolverRulesResponse$ResolverRules": "The Resolver rules that were created using the current AWS account and that match the specified filters, if any.
" } }, "ResourceExistsException": { @@ -520,32 +736,43 @@ "ResourceId": { "base": null, "refs": { - "AssociateResolverEndpointIpAddressRequest$ResolverEndpointId": "The ID of the resolver endpoint that you want to associate IP addresses with.
", - "AssociateResolverRuleRequest$ResolverRuleId": "The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.
", - "AssociateResolverRuleRequest$VPCId": "The ID of the VPC that you want to associate the resolver rule with.
", - "CreateResolverRuleRequest$ResolverEndpointId": "The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
The ID of the resolver endpoint that you want to delete.
", - "DeleteResolverRuleRequest$ResolverRuleId": "The ID of the resolver rule that you want to delete.
", - "DisassociateResolverEndpointIpAddressRequest$ResolverEndpointId": "The ID of the resolver endpoint that you want to disassociate an IP address from.
", - "DisassociateResolverRuleRequest$VPCId": "The ID of the VPC that you want to disassociate the resolver rule from.
", - "DisassociateResolverRuleRequest$ResolverRuleId": "The ID of the resolver rule that you want to disassociate from the specified VPC.
", - "GetResolverEndpointRequest$ResolverEndpointId": "The ID of the resolver endpoint that you want to get information about.
", - "GetResolverRuleAssociationRequest$ResolverRuleAssociationId": "The ID of the resolver rule association that you want to get information about.
", - "GetResolverRuleRequest$ResolverRuleId": "The ID of the resolver rule that you want to get information about.
", + "AssociateResolverEndpointIpAddressRequest$ResolverEndpointId": "The ID of the Resolver endpoint that you want to associate IP addresses with.
", + "AssociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId": "The ID of the query logging configuration that you want to associate a VPC with.
", + "AssociateResolverQueryLogConfigRequest$ResourceId": "The ID of an Amazon VPC that you want this query logging configuration to log queries for.
The VPCs and the query logging configuration must be in the same Region.
The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use ListResolverRules.
", + "AssociateResolverRuleRequest$VPCId": "The ID of the VPC that you want to associate the Resolver rule with.
", + "CreateResolverRuleRequest$ResolverEndpointId": "The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
The ID of the Resolver endpoint that you want to delete.
", + "DeleteResolverQueryLogConfigRequest$ResolverQueryLogConfigId": "The ID of the query logging configuration that you want to delete.
", + "DeleteResolverRuleRequest$ResolverRuleId": "The ID of the Resolver rule that you want to delete.
", + "DisassociateResolverEndpointIpAddressRequest$ResolverEndpointId": "The ID of the Resolver endpoint that you want to disassociate an IP address from.
", + "DisassociateResolverQueryLogConfigRequest$ResolverQueryLogConfigId": "The ID of the query logging configuration that you want to disassociate a specified VPC from.
", + "DisassociateResolverQueryLogConfigRequest$ResourceId": "The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.
", + "DisassociateResolverRuleRequest$VPCId": "The ID of the VPC that you want to disassociate the Resolver rule from.
", + "DisassociateResolverRuleRequest$ResolverRuleId": "The ID of the Resolver rule that you want to disassociate from the specified VPC.
", + "GetResolverEndpointRequest$ResolverEndpointId": "The ID of the Resolver endpoint that you want to get information about.
", + "GetResolverQueryLogConfigAssociationRequest$ResolverQueryLogConfigAssociationId": "The ID of the Resolver query logging configuration association that you want to get information about.
", + "GetResolverQueryLogConfigRequest$ResolverQueryLogConfigId": "The ID of the Resolver query logging configuration that you want to get information about.
", + "GetResolverRuleAssociationRequest$ResolverRuleAssociationId": "The ID of the Resolver rule association that you want to get information about.
", + "GetResolverRuleRequest$ResolverRuleId": "The ID of the Resolver rule that you want to get information about.
", "IpAddressResponse$IpId": "The ID of one IP address.
", - "IpAddressUpdate$IpId": "Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
", - "ListResolverEndpointIpAddressesRequest$ResolverEndpointId": "The ID of the resolver endpoint that you want to get IP addresses for.
", - "ResolverEndpoint$Id": "The ID of the resolver endpoint.
", - "ResolverEndpoint$HostVPCId": "The ID of the VPC that you want to create the resolver endpoint in.
", - "ResolverRule$Id": "The ID that Resolver assigned to the resolver rule when you created it.
", + "IpAddressUpdate$IpId": "Only when removing an IP address from a Resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.
", + "ListResolverEndpointIpAddressesRequest$ResolverEndpointId": "The ID of the Resolver endpoint that you want to get IP addresses for.
", + "ResolverEndpoint$Id": "The ID of the Resolver endpoint.
", + "ResolverEndpoint$HostVPCId": "The ID of the VPC that you want to create the Resolver endpoint in.
", + "ResolverQueryLogConfig$Id": "The ID for the query logging configuration.
", + "ResolverQueryLogConfigAssociation$Id": "The ID of the query logging association.
", + "ResolverQueryLogConfigAssociation$ResolverQueryLogConfigId": "The ID of the query logging configuration that a VPC is associated with.
", + "ResolverQueryLogConfigAssociation$ResourceId": "The ID of the Amazon VPC that is associated with the query logging configuration.
", + "ResolverRule$Id": "The ID that Resolver assigned to the Resolver rule when you created it.
", "ResolverRule$ResolverEndpointId": "The ID of the endpoint that the rule is associated with.
", - "ResolverRuleAssociation$Id": "The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
", - "ResolverRuleAssociation$ResolverRuleId": "The ID of the resolver rule that you associated with the VPC that is specified by VPCId.
The ID of the VPC that you associated the resolver rule with.
", - "ResolverRuleConfig$ResolverEndpointId": "The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
", + "ResolverRuleAssociation$ResolverRuleId": "The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
The ID of the VPC that you associated the Resolver rule with.
", + "ResolverRuleConfig$ResolverEndpointId": "The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.
The ID of the resolver endpoint that you want to update.
", - "UpdateResolverRuleRequest$ResolverRuleId": "The ID of the resolver rule that you want to update.
" + "UpdateResolverEndpointRequest$ResolverEndpointId": "The ID of the Resolver endpoint that you want to update.
", + "UpdateResolverRuleRequest$ResolverRuleId": "The ID of the Resolver rule that you want to update.
" } }, "ResourceInUseException": { @@ -569,36 +796,55 @@ "IpAddressResponse$CreationTime": "The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
", "IpAddressResponse$ModificationTime": "The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
", "ResolverEndpoint$CreationTime": "The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).
", - "ResolverEndpoint$ModificationTime": "The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
" + "ResolverEndpoint$ModificationTime": "The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).
", + "ResolverQueryLogConfig$CreationTime": "The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
", + "ResolverQueryLogConfigAssociation$CreationTime": "The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
", + "ResolverRule$CreationTime": "The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).
", + "ResolverRule$ModificationTime": "The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).
" } }, "RuleTypeOption": { "base": null, "refs": { - "CreateResolverRuleRequest$RuleType": "Specify FORWARD. Other resolver rule types aren't supported.
This value is always FORWARD. Other resolver rule types aren't supported.
When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).
", - "ResolverEndpoint$SecurityGroupIds": "The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.
" + "CreateResolverEndpointRequest$SecurityGroupIds": "The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
", + "ResolverEndpoint$SecurityGroupIds": "The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.
" } }, "ShareStatus": { "base": null, "refs": { + "ResolverQueryLogConfig$ShareStatus": "An indication of whether the query logging configuration is shared with other AWS accounts, or was shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).
", "ResolverRule$ShareStatus": "Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.
" } }, + "SortByKey": { + "base": null, + "refs": { + "ListResolverQueryLogConfigAssociationsRequest$SortBy": "The element that you want Resolver to sort query logging associations by.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
CreationTime: The ID of the query logging association.
Error: If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don't allow sending logs to the destination.
If Status is a value other than FAILED, ERROR is null.
Id: The ID of the query logging association
ResolverQueryLogConfigId: The ID of the query logging configuration
ResourceId: The ID of the VPC that is associated with the query logging configuration
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
Arn: The ARN of the query logging configuration
AssociationCount: The number of VPCs that are associated with the specified configuration
CreationTime: The date and time that Resolver returned when the configuration was created
CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created
DestinationArn: The location that logs are sent to
Id: The ID of the configuration
Name: The name of the configuration
OwnerId: The AWS account number of the account that created the configuration
ShareStatus: Whether the configuration is shared with other AWS accounts or shared with the current account by another AWS account. Sharing is configured through AWS Resource Access Manager (AWS RAM).
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don't allow sending logs to the destination.
If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.
If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.
A message that provides additional information about the status of the request.
", - "ResolverEndpoint$StatusMessage": "A detailed description of the status of the resolver endpoint.
", - "ResolverRule$StatusMessage": "A detailed description of the status of a resolver rule.
", - "ResolverRuleAssociation$StatusMessage": "A detailed description of the status of the association between a resolver rule and a VPC.
" + "ResolverEndpoint$StatusMessage": "A detailed description of the status of the Resolver endpoint.
", + "ResolverRule$StatusMessage": "A detailed description of the status of a Resolver rule.
", + "ResolverRuleAssociation$StatusMessage": "A detailed description of the status of the association between a Resolver rule and a VPC.
" } }, "String": { @@ -621,9 +867,9 @@ "SubnetId": { "base": null, "refs": { - "IpAddressRequest$SubnetId": "The subnet that contains the IP address.
", + "IpAddressRequest$SubnetId": "The ID of the subnet that contains the IP address.
", "IpAddressResponse$SubnetId": "The ID of one subnet.
", - "IpAddressUpdate$SubnetId": "The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
" + "IpAddressUpdate$SubnetId": "The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.
" } }, "Tag": { @@ -649,6 +895,7 @@ "base": null, "refs": { "CreateResolverEndpointRequest$Tags": "A list of the tag keys and values that you want to associate with the endpoint.
", + "CreateResolverQueryLogConfigRequest$Tags": "A list of the tag keys and values that you want to associate with the query logging configuration.
", "CreateResolverRuleRequest$Tags": "A list of the tag keys and values that you want to associate with the endpoint.
", "ListTagsForResourceResponse$Tags": "The tags that are associated with the resource that you specified in the ListTagsForResource request.
The tags that you want to add to the specified resource.
" @@ -671,7 +918,7 @@ } }, "TargetAddress": { - "base": "In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
", + "base": "In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
", "refs": { "TargetList$member": null } @@ -679,8 +926,8 @@ "TargetList": { "base": null, "refs": { - "CreateResolverRuleRequest$TargetIps": "The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.
", - "ResolverRule$TargetIps": "An array that contains the IP addresses and ports that you want to forward
", + "CreateResolverRuleRequest$TargetIps": "The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.
TargetIps is available only when the value of Rule type is FORWARD.
An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network. Specify IPv4 addresses. IPv6 is not supported.
", "ResolverRuleConfig$TargetIps": "For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.
" } }, diff --git a/aws-sdk-core/apis/route53resolver/2018-04-01/paginators-1.json b/aws-sdk-core/apis/route53resolver/2018-04-01/paginators-1.json index c6fb889103b..4084b7aa0f8 100644 --- a/aws-sdk-core/apis/route53resolver/2018-04-01/paginators-1.json +++ b/aws-sdk-core/apis/route53resolver/2018-04-01/paginators-1.json @@ -3,22 +3,44 @@ "ListResolverEndpointIpAddresses": { "input_token": "NextToken", "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "result_key": "IpAddresses" }, "ListResolverEndpoints": { "input_token": "NextToken", "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "result_key": "ResolverEndpoints" + }, + "ListResolverQueryLogConfigAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResolverQueryLogConfigAssociations" + }, + "ListResolverQueryLogConfigs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResolverQueryLogConfigs" }, "ListResolverRuleAssociations": { "input_token": "NextToken", "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "result_key": "ResolverRuleAssociations" }, "ListResolverRules": { "input_token": "NextToken", "output_token": "NextToken", - "limit_key": "MaxResults" + "limit_key": "MaxResults", + "result_key": "ResolverRules" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" } } } diff --git a/aws-sdk-core/endpoints.json b/aws-sdk-core/endpoints.json index 23902093f20..54fd71623a6 100644 --- a/aws-sdk-core/endpoints.json +++ b/aws-sdk-core/endpoints.json @@ -3150,6 +3150,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -7334,6 +7335,7 @@ "protocols" : [ "https" ] }, "endpoints" : { + "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, @@ -7727,11 +7729,13 @@ } }, "endpoints" : { + "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, "iotsecuredtunneling" : { "endpoints" : { + "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, diff --git a/aws-sdk-core/lib/aws-sdk-core.rb b/aws-sdk-core/lib/aws-sdk-core.rb index e709bbf6d12..9929d3cb30e 100644 --- a/aws-sdk-core/lib/aws-sdk-core.rb +++ b/aws-sdk-core/lib/aws-sdk-core.rb @@ -35,6 +35,7 @@ module Aws AppMesh AppStream AppSync + Appflow ApplicationAutoScaling ApplicationDiscoveryService ApplicationInsights diff --git a/aws-sdk-core/lib/aws-sdk-core/appflow.rb b/aws-sdk-core/lib/aws-sdk-core/appflow.rb new file mode 100644 index 00000000000..dfc5c246516 --- /dev/null +++ b/aws-sdk-core/lib/aws-sdk-core/appflow.rb @@ -0,0 +1,6 @@ +Aws.add_service(:Appflow, { + api: "#{Aws::API_DIR}/appflow/2020-08-23/api-2.json", + docs: "#{Aws::API_DIR}/appflow/2020-08-23/docs-2.json", + examples: "#{Aws::API_DIR}/appflow/2020-08-23/examples-1.json", + paginators: "#{Aws::API_DIR}/appflow/2020-08-23/paginators-1.json", +}) diff --git a/aws-sdk-core/service-models.json b/aws-sdk-core/service-models.json index f37e5c03508..5e9211d52e2 100644 --- a/aws-sdk-core/service-models.json +++ b/aws-sdk-core/service-models.json @@ -47,6 +47,10 @@ "models": "appsync/2017-07-25", "endpoint": "appsync" }, + "Appflow": { + "models": "appflow/2020-08-23", + "endpoint": "appflow" + }, "ApplicationAutoScaling": { "models": "application-autoscaling/2016-02-06", "endpoint": "application-autoscaling"