Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amazonpinpointsmsvoicev2-api-077	amazonpinpointsmsvoicev2-api.pdf	77	Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 256. Pattern: arn:[A-Za-z0-9_:/-]+ Required: Yes TagKeys An array of tag key values to unassociate with the resource. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 200 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .+ Required: Yes UntagResource API Version 2022-03-31 380 AWS End User Messaging SMS Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Response Elements API Version 2022-03-31 381 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 382 AWS End User Messaging SMS API Reference UpdateEventDestination Updates an existing event destination in a conﬁguration set. You can update the IAM role ARN for CloudWatch Logs and Firehose. You can also enable or disable the event destination. You may want to update an event destination to change its matching event types or updating the destination resource ARN. You can't change an event destination's type between CloudWatch Logs, Firehose, and Amazon SNS. Request Syntax { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" }, "ConfigurationSetName": "string", "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CloudWatchLogsDestination An object that contains information about an event destination that sends data to CloudWatch Logs. Type: CloudWatchLogsDestination object UpdateEventDestination API Version 2022-03-31 383 AWS End User Messaging SMS Required: No ConﬁgurationSetName API Reference The conﬁguration set to update with the new event destination. Valid values for this can be the ConﬁgurationSetName or ConﬁgurationSetArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Enabled When set to true logging is enabled. Type: Boolean Required: No EventDestinationName The name to use for the event destination. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes KinesisFirehoseDestination An object that contains information about an event destination for logging to Firehose. Type: KinesisFirehoseDestination object Required: No MatchingEventTypes An array of event types that determine which events to log. Request Parameters API Version 2022-03-31 384 AWS End User Messaging SMS API Reference Note The TEXT_SENT event type is not supported. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 43 items. Valid Values: ALL \| TEXT_ALL \| TEXT_SENT \| TEXT_PENDING \| TEXT_QUEUED \| TEXT_SUCCESSFUL \| TEXT_DELIVERED \| TEXT_INVALID \| TEXT_INVALID_MESSAGE \| TEXT_UNREACHABLE \| TEXT_CARRIER_UNREACHABLE \| TEXT_BLOCKED \| TEXT_CARRIER_BLOCKED \| TEXT_SPAM \| TEXT_UNKNOWN \| TEXT_TTL_EXPIRED \| TEXT_PROTECT_BLOCKED \| VOICE_ALL \| VOICE_INITIATED \| VOICE_RINGING \| VOICE_ANSWERED \| VOICE_COMPLETED \| VOICE_BUSY \| VOICE_NO_ANSWER \| VOICE_FAILED \| VOICE_TTL_EXPIRED \| MEDIA_ALL \| MEDIA_PENDING \| MEDIA_QUEUED \| MEDIA_SUCCESSFUL \| MEDIA_DELIVERED \| MEDIA_INVALID \| MEDIA_INVALID_MESSAGE \| MEDIA_UNREACHABLE \| MEDIA_CARRIER_UNREACHABLE \| MEDIA_BLOCKED \| MEDIA_CARRIER_BLOCKED \| MEDIA_SPAM \| MEDIA_UNKNOWN \| MEDIA_TTL_EXPIRED \| MEDIA_FILE_INACCESSIBLE \| MEDIA_FILE_TYPE_UNSUPPORTED \| MEDIA_FILE_SIZE_EXCEEDED Required: No SnsDestination An object that contains information about an event destination that sends data to Amazon SNS. Type: SnsDestination object Required: No Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "EventDestination": { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" Response Syntax API Version 2022-03-31 385 AWS End User Messaging SMS API Reference }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } } Response Elements If the action is successful, the service sends back an
amazonpinpointsmsvoicev2-api-078	amazonpinpointsmsvoicev2-api.pdf	78	\| MEDIA_CARRIER_BLOCKED \| MEDIA_SPAM \| MEDIA_UNKNOWN \| MEDIA_TTL_EXPIRED \| MEDIA_FILE_INACCESSIBLE \| MEDIA_FILE_TYPE_UNSUPPORTED \| MEDIA_FILE_SIZE_EXCEEDED Required: No SnsDestination An object that contains information about an event destination that sends data to Amazon SNS. Type: SnsDestination object Required: No Response Syntax { "ConfigurationSetArn": "string", "ConfigurationSetName": "string", "EventDestination": { "CloudWatchLogsDestination": { "IamRoleArn": "string", "LogGroupArn": "string" Response Syntax API Version 2022-03-31 385 AWS End User Messaging SMS API Reference }, "Enabled": boolean, "EventDestinationName": "string", "KinesisFirehoseDestination": { "DeliveryStreamArn": "string", "IamRoleArn": "string" }, "MatchingEventTypes": [ "string" ], "SnsDestination": { "TopicArn": "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ConﬁgurationSetArn The Amazon Resource Name (ARN) for the ConﬁgurationSet that was updated. Type: String ConﬁgurationSetName The name of the conﬁguration set. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ EventDestination An EventDestination object containing the details of where events will be logged. Type: EventDestination object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2022-03-31 386 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 ConﬂictException Your request has conﬂicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or conﬁguration of the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2022-03-31 387 API Reference AWS End User Messaging SMS • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 388 AWS End User Messaging SMS API Reference UpdatePhoneNumber Updates the conﬁguration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self- managed opt-outs, and enable or disable deletion protection. If the origination phone number is associated with a pool, an error is returned. Request Syntax { "DeletionProtectionEnabled": boolean, "OptOutListName": "string", "PhoneNumberId": "string", "SelfManagedOptOutsEnabled": boolean, "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionProtectionEnabled By default this is set to false. When set to true the phone number can't be deleted. Type: Boolean Required: No OptOutListName The OptOutList to add the phone number to. Valid values for this ﬁeld can be either the OutOutListName or OutOutListArn. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. UpdatePhoneNumber API Version 2022-03-31 389 AWS End User Messaging SMS API Reference Pattern: [A-Za-z0-9_:/-]+ Required: No PhoneNumberId The unique identiﬁer of the phone number. Valid values for this ﬁeld can be either the PhoneNumberId or PhoneNumberArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean Required: No TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ Request Parameters API Version 2022-03-31 390 AWS End User Messaging SMS Required: No TwoWayChannelRole API Reference An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length
amazonpinpointsmsvoicev2-api-079	amazonpinpointsmsvoicev2-api.pdf	79	end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean Required: No TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ Request Parameters API Version 2022-03-31 390 AWS End User Messaging SMS Required: No TwoWayChannelRole API Reference An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: No TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Required: No Response Syntax { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageType": "string", "MonthlyLeasingPrice": "string", "NumberCapabilities": [ "string" ], "NumberType": "string", "OptOutListName": "string", "PhoneNumber": "string", "PhoneNumberArn": "string", "PhoneNumberId": "string", "RegistrationId": "string", "SelfManagedOptOutsEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean Response Syntax API Version 2022-03-31 391 AWS End User Messaging SMS } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the phone number was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled When set to true the phone number can't be deleted. Type: Boolean IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL \| PROMOTIONAL MonthlyLeasingPrice The monthly leasing price of the phone number, in US dollars. Type: String Response Elements API Version 2022-03-31 392 AWS End User Messaging SMS NumberCapabilities API Reference Speciﬁes if the number could be used for text messages, voice or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS \| VOICE \| MMS NumberType The type of number that was requested. Type: String Valid Values: SHORT_CODE \| LONG_CODE \| TOLL_FREE \| TEN_DLC \| SIMULATOR OptOutListName The name of the OptOutList associated with the phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ PhoneNumber The phone number that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} PhoneNumberArn The Amazon Resource Name (ARN) of the updated phone number. Type: String PhoneNumberId The unique identiﬁer of the phone number. Response Elements API Version 2022-03-31 393 API Reference AWS End User Messaging SMS Type: String RegistrationId The unique identiﬁer for the registration. Type: String SelfManagedOptOutsEnabled This is true if self managed opt-out are enabled. Type: Boolean Status The current status of the request. Type: String Valid Values: PENDING \| ACTIVE \| ASSOCIATING \| DISASSOCIATING \| DELETED TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Response Elements API Version 2022-03-31 394 AWS End User Messaging SMS Type: Boolean Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 ConﬂictException Your request has conﬂicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or conﬁguration of the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 Errors API Version 2022-03-31 395 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for
amazonpinpointsmsvoicev2-api-080	amazonpinpointsmsvoicev2-api.pdf	80	successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 Errors API Version 2022-03-31 395 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 396 AWS End User Messaging SMS UpdatePool API Reference Updates the conﬁguration of an existing pool. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, enable or disable deletion protection, and enable or disable shared routes. Request Syntax { "DeletionProtectionEnabled": boolean, "OptOutListName": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, "SharedRoutesEnabled": boolean, "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionProtectionEnabled When set to true the pool can't be deleted. Type: Boolean Required: No OptOutListName The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). UpdatePool API Version 2022-03-31 397 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No PoolId The unique identiﬁer of the pool to update. Valid values are either the PoolId or PoolArn. Important If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes SelfManagedOptOutsEnabled By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean Required: No SharedRoutesEnabled Indicates whether shared routes are enabled for the pool. Type: Boolean Request Parameters API Version 2022-03-31 398 AWS End User Messaging SMS Required: No TwoWayChannelArn API Reference The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ Required: No TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: No TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Required: No Response Syntax { "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "MessageType": "string", "OptOutListName": "string", "PoolArn": "string", "PoolId": "string", "SelfManagedOptOutsEnabled": boolean, Response Syntax API Version 2022-03-31 399 AWS End User Messaging SMS API Reference "SharedRoutesEnabled": boolean, "Status": "string", "TwoWayChannelArn": "string", "TwoWayChannelRole": "string", "TwoWayEnabled": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the pool was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled When set to true the pool can't be deleted. Type: Boolean MessageType The type of message for the pool to use. Type: String Valid Values: TRANSACTIONAL \| PROMOTIONAL OptOutListName The name of the OptOutList associated with the pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ PoolArn The ARN of the pool. Response Elements API Version 2022-03-31 400 AWS End User Messaging SMS Type: String PoolId The unique identiﬁer of the pool. Type: String SelfManagedOptOutsEnabled API Reference When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean SharedRoutesEnabled Indicates whether shared routes are
amazonpinpointsmsvoicev2-api-081	amazonpinpointsmsvoicev2-api.pdf	81	The ARN of the pool. Response Elements API Version 2022-03-31 400 AWS End User Messaging SMS Type: String PoolId The unique identiﬁer of the pool. Type: String SelfManagedOptOutsEnabled API Reference When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. Type: Boolean SharedRoutesEnabled Indicates whether shared routes are enabled for the pool. Type: Boolean Status The current status of the pool update request. Type: String Valid Values: CREATING \| ACTIVE \| DELETING TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Response Elements API Version 2022-03-31 401 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 ConﬂictException Your request has conﬂicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or conﬁguration of the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. Errors API Version 2022-03-31 402 AWS End User Messaging SMS HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 403 AWS End User Messaging SMS API Reference UpdateProtectConﬁguration Update the setting for an existing protect conﬁguration. Request Syntax { "DeletionProtectionEnabled": boolean, "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionProtectionEnabled When set to true deletion protection is enabled. By default this is set to false. Type: Boolean Required: No ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "AccountDefault": boolean, UpdateProtectConﬁguration API Version 2022-03-31 404 AWS End User Messaging SMS API Reference "CreatedTimestamp": number, "DeletionProtectionEnabled": boolean, "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AccountDefault This is true if the protect conﬁguration is set as your account default protect conﬁguration. Type: Boolean CreatedTimestamp The time when the protect conﬁguration was created, in UNIX epoch time format. Type: Timestamp DeletionProtectionEnabled The status of deletion protection for the protect conﬁguration. When set to true deletion protection is enabled. By default this is set to false. Type: Boolean ProtectConﬁgurationArn The Amazon Resource Name (ARN) of the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. Type: String Response Elements API Version 2022-03-31 405 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be
amazonpinpointsmsvoicev2-api-082	amazonpinpointsmsvoicev2-api.pdf	82	for the protect conﬁguration. Type: String Response Elements API Version 2022-03-31 405 AWS End User Messaging SMS API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2022-03-31 406 API Reference AWS End User Messaging SMS • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 407 AWS End User Messaging SMS API Reference UpdateProtectConﬁgurationCountryRuleSet Update a country rule set to ALLOW, BLOCK, MONITOR, or FILTER messages to be sent to the speciﬁed destination counties. You can update one or multiple countries at a time. The updates are only applied to the speciﬁed NumberCapability type. Request Syntax { "CountryRuleSetUpdates": { "string" : { "ProtectStatus": "string" } }, "NumberCapability": "string", "ProtectConfigurationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. CountryRuleSetUpdates A map of ProtectConﬁgurationCountryRuleSetInformation objects that contain the details for the requested NumberCapability. The Key is the two-letter ISO country code. For a list of supported ISO country codes, see Supported countries and regions (SMS channel) in the AWS End User Messaging SMS User Guide. For example, to set the United States as allowed and Canada as blocked, the CountryRuleSetUpdates would be formatted as: "CountryRuleSetUpdates": { "US" : { "ProtectStatus": "ALLOW" } "CA" : { "ProtectStatus": "BLOCK" } } Type: String to ProtectConﬁgurationCountryRuleSetInformation object map Map Entries: Maximum number of 300 items. Key Length Constraints: Fixed length of 2. UpdateProtectConﬁgurationCountryRuleSet API Version 2022-03-31 408 API Reference AWS End User Messaging SMS Key Pattern: [A-Z]{2} Required: Yes NumberCapability The number capability to apply the CountryRuleSetUpdates updates to. Type: String Valid Values: SMS \| VOICE \| MMS Required: Yes ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "CountryRuleSet": { "string" : { "ProtectStatus": "string" } }, "NumberCapability": "string", "ProtectConfigurationArn": "string", "ProtectConfigurationId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2022-03-31 409 AWS End User Messaging SMS CountryRuleSet API Reference An array of ProtectConﬁgurationCountryRuleSetInformation containing the rules for the NumberCapability. Type: String to ProtectConﬁgurationCountryRuleSetInformation object map Map Entries: Maximum number of 300 items. Key Length Constraints: Fixed length of 2. Key Pattern: [A-Z]{2} NumberCapability The number capability that was updated Type: String Valid Values: SMS \| VOICE \| MMS ProtectConﬁgurationArn The Amazon Resource Name (ARN) of the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Errors For information about the errors that are common to all actions, see Common Errors. Errors API Version 2022-03-31 410 AWS End User Messaging SMS AccessDeniedException API Reference The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 •
amazonpinpointsmsvoicev2-api-083	amazonpinpointsmsvoicev2-api.pdf	83	the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2022-03-31 411 AWS End User Messaging SMS • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 412 API Reference AWS End User Messaging SMS UpdateSenderId Updates the conﬁguration of an existing sender ID. Request Syntax { "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "SenderId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. Type: Boolean Required: No IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes SenderId The sender ID to update. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. UpdateSenderId API Version 2022-03-31 413 AWS End User Messaging SMS API Reference Pattern: [A-Za-z0-9_:/-]+ Required: Yes Response Syntax { "DeletionProtectionEnabled": boolean, "IsoCountryCode": "string", "MessageTypes": [ "string" ], "MonthlyLeasingPrice": "string", "Registered": boolean, "RegistrationId": "string", "SenderId": "string", "SenderIdArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. Type: Boolean IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Response Syntax API Version 2022-03-31 414 AWS End User Messaging SMS Type: Array of strings API Reference Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL \| PROMOTIONAL MonthlyLeasingPrice The monthly price, in US dollars, to lease the sender ID. Type: String Registered True if the sender ID is registered.. Type: Boolean RegistrationId The unique identiﬁer for the registration. Type: String SenderId The sender ID that was updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ SenderIdArn The Amazon Resource Name (ARN) associated with the SenderId. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. Errors API Version 2022-03-31 415 AWS End User Messaging SMS HTTP Status Code: 400 InternalServerException API Reference The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python See Also API Version 2022-03-31 416 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 417 AWS End User Messaging SMS API Reference VerifyDestinationNumber Use the veriﬁcation code that was received by the veriﬁed destination phone number to opt-in the veriﬁed destination phone number to receive more messages. Request Syntax { "VerificationCode": "string", "VerifiedDestinationNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VeriﬁcationCode The veriﬁcation code that was received by the veriﬁed destination phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [A-Za-z0-9]+
amazonpinpointsmsvoicev2-api-084	amazonpinpointsmsvoicev2-api.pdf	84	API Reference See Also API Version 2022-03-31 417 AWS End User Messaging SMS API Reference VerifyDestinationNumber Use the veriﬁcation code that was received by the veriﬁed destination phone number to opt-in the veriﬁed destination phone number to receive more messages. Request Syntax { "VerificationCode": "string", "VerifiedDestinationNumberId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. VeriﬁcationCode The veriﬁcation code that was received by the veriﬁed destination phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: [A-Za-z0-9]+ Required: Yes VeriﬁedDestinationNumberId The unique identiﬁer for the veriﬁfed destination phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes VerifyDestinationNumber API Version 2022-03-31 418 API Reference AWS End User Messaging SMS Response Syntax { "CreatedTimestamp": number, "DestinationPhoneNumber": "string", "Status": "string", "VerifiedDestinationNumberArn": "string", "VerifiedDestinationNumberId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreatedTimestamp The time when the destination phone number was created, in UNIX epoch time format. Type: Timestamp DestinationPhoneNumber The phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Status The status for being able to send messages to the phone number. Type: String Valid Values: PENDING \| VERIFIED VeriﬁedDestinationNumberArn The Amazon Resource Name (ARN) for the veriﬁed destination phone number. Type: String Response Syntax API Version 2022-03-31 419 AWS End User Messaging SMS VeriﬁedDestinationNumberId API Reference The unique identiﬁer for the veriﬁed destination phone number. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException The request was denied because you don't have suﬃcient permissions to access the resource. HTTP Status Code: 400 ConﬂictException Your request has conﬂicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or conﬁguration of the resource. HTTP Status Code: 400 InternalServerException The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future. HTTP Status Code: 500 ResourceNotFoundException A requested resource couldn't be found. HTTP Status Code: 400 ThrottlingException An error that occurred because too many requests were sent during a certain amount of time. HTTP Status Code: 400 ValidationException A validation exception for a ﬁeld. Errors API Version 2022-03-31 420 AWS End User Messaging SMS HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2022-03-31 421 AWS End User Messaging SMS Data Types API Reference The Amazon Pinpoint SMS Voice V2 API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountAttribute • AccountLimit • CloudWatchLogsDestination • ConﬁgurationSetFilter • ConﬁgurationSetInformation • EventDestination • KeywordFilter • KeywordInformation • KinesisFirehoseDestination • OptedOutFilter • OptedOutNumberInformation • OptOutListInformation • OriginationIdentityMetadata • PhoneNumberFilter • PhoneNumberInformation • PoolFilter • PoolInformation • PoolOriginationIdentitiesFilter • ProtectConﬁgurationCountryRuleSetInformation • ProtectConﬁgurationFilter API Version 2022-03-31 422 AWS End User Messaging SMS API Reference • ProtectConﬁgurationInformation • ProtectConﬁgurationRuleSetNumberOverride • ProtectConﬁgurationRuleSetNumberOverrideFilterItem • RegistrationAssociationFilter • RegistrationAssociationMetadata • RegistrationAttachmentFilter • RegistrationAttachmentsInformation • RegistrationDeniedReasonInformation • RegistrationFieldDeﬁnition • RegistrationFieldDisplayHints • RegistrationFieldValueInformation • RegistrationFilter • RegistrationInformation • RegistrationSectionDeﬁnition • RegistrationSectionDisplayHints • RegistrationTypeDeﬁnition • RegistrationTypeDisplayHints • RegistrationTypeFilter • RegistrationVersionFilter • RegistrationVersionInformation • RegistrationVersionStatusHistory • SelectOptionDescription • SelectValidation • SenderIdAndCountry • SenderIdFilter • SenderIdInformation • SnsDestination • SpendLimit • SupportedAssociation • Tag API Version 2022-03-31 423 AWS End User Messaging SMS • TextValidation • ValidationExceptionField • VeriﬁedDestinationNumberFilter • VeriﬁedDestinationNumberInformation API Reference API Version 2022-03-31 424 AWS End User Messaging SMS AccountAttribute Displays the attributes associated with a single AWS account. API Reference Contents Name The name of the account attribute. Type: String Valid Values: ACCOUNT_TIER \| DEFAULT_PROTECT_CONFIGURATION_ID Required: Yes Value The value associated with the account attribute name. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3
amazonpinpointsmsvoicev2-api-085	amazonpinpointsmsvoicev2-api.pdf	85	User Messaging SMS • TextValidation • ValidationExceptionField • VeriﬁedDestinationNumberFilter • VeriﬁedDestinationNumberInformation API Reference API Version 2022-03-31 424 AWS End User Messaging SMS AccountAttribute Displays the attributes associated with a single AWS account. API Reference Contents Name The name of the account attribute. Type: String Valid Values: ACCOUNT_TIER \| DEFAULT_PROTECT_CONFIGURATION_ID Required: Yes Value The value associated with the account attribute name. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccountAttribute API Version 2022-03-31 425 AWS End User Messaging SMS AccountLimit The current resource quotas associated with an AWS account. API Reference Contents Max The AWS set limit for that resource type, in US dollars. Type: Long Required: Yes Name The name of the attribute to apply the account limit to. Type: String Valid Values: PHONE_NUMBERS \| POOLS \| CONFIGURATION_SETS \| OPT_OUT_LISTS \| SENDER_IDS \| REGISTRATIONS \| REGISTRATION_ATTACHMENTS \| VERIFIED_DESTINATION_NUMBERS Required: Yes Used The current amount that has been spent, in US dollars. Type: Long Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AccountLimit API Version 2022-03-31 426 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 427 AWS End User Messaging SMS API Reference CloudWatchLogsDestination Contains the destination conﬁguration to use when publishing message sending events. Contents IamRoleArn The Amazon Resource Name (ARN) of an AWS Identity and Access Management role that is able to write event data to an Amazon CloudWatch destination. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes LogGroupArn The name of the Amazon CloudWatch log group that you want to record events in. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CloudWatchLogsDestination API Version 2022-03-31 428 AWS End User Messaging SMS API Reference ConﬁgurationSetFilter The information for conﬁguration sets that meet a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: event-destination-name \| matching-event-types \| default- message-type \| default-sender-id \| default-message-feedback-enabled \| protect-configuration-id Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConﬁgurationSetFilter API Version 2022-03-31 429 AWS End User Messaging SMS API Reference ConﬁgurationSetInformation Information related to a given conﬁguration set in your AWS account. Contents ConﬁgurationSetArn The Resource Name (ARN) of the ConﬁgurationSet. Type: String Required: Yes ConﬁgurationSetName The name of the ConﬁgurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes CreatedTimestamp The time when the ConﬁgurationSet was created, in UNIX epoch time format. Type: Timestamp Required: Yes EventDestinations An array of EventDestination objects that describe any events to log and where to log them. Type: Array of EventDestination objects Required: Yes DefaultMessageFeedbackEnabled True if message feedback is enabled. ConﬁgurationSetInformation API Version 2022-03-31 430 AWS End User Messaging SMS Type: Boolean Required: No DefaultMessageType API Reference The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL \| PROMOTIONAL Required: No DefaultSenderId The default sender ID used by the ConﬁgurationSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Required: No ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2022-03-31 431 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 432 AWS End User Messaging SMS EventDestination Contains information about an event destination. API Reference Event destinations are associated with conﬁguration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS. Contents Enabled When set to true events will
amazonpinpointsmsvoicev2-api-086	amazonpinpointsmsvoicev2-api.pdf	86	Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2022-03-31 431 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 432 AWS End User Messaging SMS EventDestination Contains information about an event destination. API Reference Event destinations are associated with conﬁguration sets, which enable you to publish message sending events to CloudWatch, Firehose, or Amazon SNS. Contents Enabled When set to true events will be logged. Type: Boolean Required: Yes EventDestinationName The name of the EventDestination. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes MatchingEventTypes An array of event types that determine which events to log. Note The TEXT_SENT event type is not supported. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 43 items. Valid Values: ALL \| TEXT_ALL \| TEXT_SENT \| TEXT_PENDING \| TEXT_QUEUED \| TEXT_SUCCESSFUL \| TEXT_DELIVERED \| TEXT_INVALID \| TEXT_INVALID_MESSAGE \| TEXT_UNREACHABLE \| TEXT_CARRIER_UNREACHABLE \| TEXT_BLOCKED \| EventDestination API Version 2022-03-31 433 AWS End User Messaging SMS API Reference TEXT_CARRIER_BLOCKED \| TEXT_SPAM \| TEXT_UNKNOWN \| TEXT_TTL_EXPIRED \| TEXT_PROTECT_BLOCKED \| VOICE_ALL \| VOICE_INITIATED \| VOICE_RINGING \| VOICE_ANSWERED \| VOICE_COMPLETED \| VOICE_BUSY \| VOICE_NO_ANSWER \| VOICE_FAILED \| VOICE_TTL_EXPIRED \| MEDIA_ALL \| MEDIA_PENDING \| MEDIA_QUEUED \| MEDIA_SUCCESSFUL \| MEDIA_DELIVERED \| MEDIA_INVALID \| MEDIA_INVALID_MESSAGE \| MEDIA_UNREACHABLE \| MEDIA_CARRIER_UNREACHABLE \| MEDIA_BLOCKED \| MEDIA_CARRIER_BLOCKED \| MEDIA_SPAM \| MEDIA_UNKNOWN \| MEDIA_TTL_EXPIRED \| MEDIA_FILE_INACCESSIBLE \| MEDIA_FILE_TYPE_UNSUPPORTED \| MEDIA_FILE_SIZE_EXCEEDED Required: Yes CloudWatchLogsDestination An object that contains information about an event destination that sends logging events to Amazon CloudWatch logs. Type: CloudWatchLogsDestination object Required: No KinesisFirehoseDestination An object that contains information about an event destination for logging to Amazon Data Firehose. Type: KinesisFirehoseDestination object Required: No SnsDestination An object that contains information about an event destination that sends logging events to Amazon SNS. Type: SnsDestination object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2022-03-31 434 AWS End User Messaging SMS • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 435 AWS End User Messaging SMS KeywordFilter The information for keywords that meet a speciﬁed criteria. API Reference Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: keyword-action Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 KeywordFilter API Version 2022-03-31 436 AWS End User Messaging SMS API Reference KeywordInformation The information for all keywords in a pool. Contents Keyword The keyword as a string. Type: String Length Constraints: Minimum length of 1. Maximum length of 30. Pattern: [ \S]+ Required: Yes KeywordAction The action to perform for the keyword. Type: String Valid Values: AUTOMATIC_RESPONSE \| OPT_OUT \| OPT_IN Required: Yes KeywordMessage A custom message that can be used with the keyword. Type: String Length Constraints: Minimum length of 1. Maximum length of 1600. Pattern: (?!\s*$)[\s\S]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: KeywordInformation API Version 2022-03-31 437 AWS End User Messaging SMS • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 438 AWS End User Messaging SMS API Reference KinesisFirehoseDestination Contains the delivery stream Amazon Resource Name (ARN), and the ARN of the AWS Identity and Access Management (IAM) role associated with a Firehose event destination. Event destinations, such as Firehose, are associated with conﬁguration sets, which enable you to publish message sending events. Contents DeliveryStreamArn The Amazon Resource Name (ARN) of the delivery stream. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes IamRoleArn The ARN of an AWS Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ KinesisFirehoseDestination API Version 2022-03-31 439 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK
amazonpinpointsmsvoicev2-api-087	amazonpinpointsmsvoicev2-api.pdf	87	stream. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes IamRoleArn The ARN of an AWS Identity and Access Management role that is able to write event data to an Amazon Data Firehose destination. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ KinesisFirehoseDestination API Version 2022-03-31 439 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 440 AWS End User Messaging SMS OptedOutFilter API Reference The information for opted out numbers that meet a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: end-user-opted-out Required: Yes Values An array of values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OptedOutFilter API Version 2022-03-31 441 AWS End User Messaging SMS API Reference OptedOutNumberInformation The information for an opted out number in an AWS account. Contents EndUserOptedOut This is set to true if it was the end recipient that opted out. Type: Boolean Required: Yes OptedOutNumber The phone number that is opted out. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes OptedOutTimestamp The time that the op tout occurred, in UNIX epoch time format. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OptedOutNumberInformation API Version 2022-03-31 442 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 443 AWS End User Messaging SMS API Reference OptOutListInformation The information for all OptOutList in an AWS account. Contents CreatedTimestamp The time when the OutOutList was created, in UNIX epoch time format. Type: Timestamp Required: Yes OptOutListArn The Amazon Resource Name (ARN) of the OptOutList. Type: String Required: Yes OptOutListName The name of the OptOutList. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OptOutListInformation API Version 2022-03-31 444 AWS End User Messaging SMS API Reference See Also API Version 2022-03-31 445 AWS End User Messaging SMS API Reference OriginationIdentityMetadata The metadata for an origination identity associated with a pool. Contents IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes NumberCapabilities Describes if the origination identity can be used for text messages, voice calls or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS \| VOICE \| MMS Required: Yes OriginationIdentity The unique identiﬁer of the origination identity. Type: String Required: Yes OriginationIdentityArn The Amazon Resource Name (ARN) associated with the origination identity. Type: String Required: Yes OriginationIdentityMetadata API Version 2022-03-31 446 API Reference AWS End User Messaging SMS PhoneNumber The phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 447 AWS End User Messaging SMS PhoneNumberFilter API Reference The information for a phone number that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: status \| iso-country-code \| message-type \| number-capability \| number-type \| two-way-enabled \| self-managed-opt-outs-enabled \| opt-out- list-name \| deletion-protection-enabled \| two-way-channel-arn Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for
amazonpinpointsmsvoicev2-api-088	amazonpinpointsmsvoicev2-api.pdf	88	to ﬁlter on. Type: String Valid Values: status \| iso-country-code \| message-type \| number-capability \| number-type \| two-way-enabled \| self-managed-opt-outs-enabled \| opt-out- list-name \| deletion-protection-enabled \| two-way-channel-arn Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PhoneNumberFilter API Version 2022-03-31 448 AWS End User Messaging SMS API Reference PhoneNumberInformation The information for a phone number, in E.164 format, in an AWS account. Contents CreatedTimestamp The time when the phone number was created, in UNIX epoch time format. Type: Timestamp Required: Yes DeletionProtectionEnabled When set to true the phone number can't be deleted. Type: Boolean Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL \| PROMOTIONAL Required: Yes PhoneNumberInformation API Version 2022-03-31 449 AWS End User Messaging SMS MonthlyLeasingPrice The price, in US dollars, to lease the phone number. API Reference Type: String Required: Yes NumberCapabilities Describes if the origination identity can be used for text messages, voice calls or both. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Valid Values: SMS \| VOICE \| MMS Required: Yes NumberType The type of phone number. Type: String Valid Values: SHORT_CODE \| LONG_CODE \| TOLL_FREE \| TEN_DLC \| SIMULATOR Required: Yes OptOutListName The name of the OptOutList associated with the phone number. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes PhoneNumber The phone number in E.164 format. Contents API Version 2022-03-31 450 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes PhoneNumberArn The Amazon Resource Name (ARN) associated with the phone number. Type: String Required: Yes SelfManagedOptOutsEnabled When set to false an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out request. For more information see Self-managed opt-outs Type: Boolean Required: Yes Status The current status of the phone number. Type: String Valid Values: PENDING \| ACTIVE \| ASSOCIATING \| DISASSOCIATING \| DELETED Required: Yes TwoWayEnabled By default this is set to false. When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn. Type: Boolean Required: Yes Contents API Version 2022-03-31 451 API Reference AWS End User Messaging SMS PhoneNumberId The unique identiﬁer for the phone number. Type: String Required: No PoolId The unique identiﬁer of the pool associated with the phone number. Type: String Required: No RegistrationId The unique identiﬁer for the registration. Type: String Required: No TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ Required: No TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: No Contents API Version 2022-03-31 452 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 453 API Reference AWS End User Messaging SMS PoolFilter The information for a pool that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: status \| message-type \| two-way-enabled \| self-managed-opt- outs-enabled \| opt-out-list-name \| shared-routes-enabled \| deletion- protection-enabled \| two-way-channel-arn Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for
amazonpinpointsmsvoicev2-api-089	amazonpinpointsmsvoicev2-api.pdf	89	speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: status \| message-type \| two-way-enabled \| self-managed-opt- outs-enabled \| opt-out-list-name \| shared-routes-enabled \| deletion- protection-enabled \| two-way-channel-arn Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PoolFilter API Version 2022-03-31 454 API Reference AWS End User Messaging SMS PoolInformation The information for a pool in an AWS account. Contents CreatedTimestamp The time when the pool was created, in UNIX epoch time format. Type: Timestamp Required: Yes DeletionProtectionEnabled When set to true the pool can't be deleted. Type: Boolean Required: Yes MessageType The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: String Valid Values: TRANSACTIONAL \| PROMOTIONAL Required: Yes OptOutListName The name of the OptOutList associated with the pool. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes PoolInformation API Version 2022-03-31 455 AWS End User Messaging SMS PoolArn The Amazon Resource Name (ARN) for the pool. API Reference Type: String Required: Yes PoolId The unique identiﬁer for the pool. Type: String Required: Yes SelfManagedOptOutsEnabled When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. For more information see Self-managed opt-outs Type: Boolean Required: Yes SharedRoutesEnabled Allows you to enable shared routes on your pool. By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code. Type: Boolean Required: Yes Status The current status of the pool. Contents API Version 2022-03-31 456 AWS End User Messaging SMS Type: String Valid Values: CREATING \| ACTIVE \| DELETING Required: Yes TwoWayEnabled API Reference When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn. Type: Boolean Required: Yes TwoWayChannelArn The Amazon Resource Name (ARN) of the two way channel. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: \S+ Required: No TwoWayChannelRole An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2022-03-31 457 AWS End User Messaging SMS • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 458 AWS End User Messaging SMS API Reference PoolOriginationIdentitiesFilter Information about origination identities associated with a pool that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: iso-country-code \| number-capability Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PoolOriginationIdentitiesFilter API Version 2022-03-31 459 AWS End User Messaging SMS API Reference ProtectConﬁgurationCountryRuleSetInformation The types of statuses that can be used. Contents ProtectStatus The types of protection that can be used. Type: String Valid Values: ALLOW \| BLOCK \| MONITOR \| FILTER Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProtectConﬁgurationCountryRuleSetInformation API Version 2022-03-31 460 AWS End User Messaging SMS API Reference ProtectConﬁgurationFilter The ﬁlter deﬁnition for ﬁltering protect conﬁgurations that meet a speciﬁed criteria. Contents Name The name of
amazonpinpointsmsvoicev2-api-090	amazonpinpointsmsvoicev2-api.pdf	90	API Reference ProtectConﬁgurationCountryRuleSetInformation The types of statuses that can be used. Contents ProtectStatus The types of protection that can be used. Type: String Valid Values: ALLOW \| BLOCK \| MONITOR \| FILTER Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProtectConﬁgurationCountryRuleSetInformation API Version 2022-03-31 460 AWS End User Messaging SMS API Reference ProtectConﬁgurationFilter The ﬁlter deﬁnition for ﬁltering protect conﬁgurations that meet a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: account-default \| deletion-protection-enabled Required: Yes Values An array of values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProtectConﬁgurationFilter API Version 2022-03-31 461 AWS End User Messaging SMS API Reference ProtectConﬁgurationInformation Provides information on the speciﬁed protect conﬁguration. Contents AccountDefault This is true if the protect conﬁguration is set as your account default protect conﬁguration. Type: Boolean Required: Yes CreatedTimestamp The time when the protect conﬁguration was created, in UNIX epoch time format. Type: Timestamp Required: Yes DeletionProtectionEnabled The status of deletion protection for the protect conﬁguration. When set to true deletion protection is enabled. By default this is set to false. Type: Boolean Required: Yes ProtectConﬁgurationArn The Amazon Resource Name (ARN) of the protect conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: arn:\S+ Required: Yes ProtectConﬁgurationId The unique identiﬁer for the protect conﬁguration. ProtectConﬁgurationInformation API Version 2022-03-31 462 AWS End User Messaging SMS Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 463 AWS End User Messaging SMS API Reference ProtectConﬁgurationRuleSetNumberOverride Provides details on phone number rule overrides for a protect conﬁguration. Contents Action The action for the rule to perform of either blocking or allowing messages to the destination phone number. Type: String Valid Values: ALLOW \| BLOCK Required: Yes CreatedTimestamp The time when the rule was created, in UNIX epoch time format. Type: Timestamp Required: Yes DestinationPhoneNumber The destination phone number in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes ExpirationTimestamp The time the rule will expire at. If ExpirationTimestamp is not set then the rule will not expire. Type: Timestamp Required: No ProtectConﬁgurationRuleSetNumberOverride API Version 2022-03-31 464 AWS End User Messaging SMS IsoCountryCode API Reference The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 465 AWS End User Messaging SMS API Reference ProtectConﬁgurationRuleSetNumberOverrideFilterItem The information for a protect conﬁguration rule set number override that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: iso-country-code \| destination-phone-number-begins-with \| action \| expires-before \| expires-after \| created-before \| created-after Required: Yes Values An array values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProtectConﬁgurationRuleSetNumberOverrideFilterItem API Version 2022-03-31 466 AWS End User Messaging SMS API Reference RegistrationAssociationFilter The ﬁlter deﬁnition for ﬁltering registrations that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: resource-type \| iso-country-code Required: Yes Values An array of values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK
amazonpinpointsmsvoicev2-api-091	amazonpinpointsmsvoicev2-api.pdf	91	2022-03-31 466 AWS End User Messaging SMS API Reference RegistrationAssociationFilter The ﬁlter deﬁnition for ﬁltering registrations that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: resource-type \| iso-country-code Required: Yes Values An array of values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationAssociationFilter API Version 2022-03-31 467 AWS End User Messaging SMS API Reference RegistrationAssociationMetadata Metadata for the origination identity that is associated with the registration. Contents ResourceArn The Amazon Resource Name (ARN) of the origination identity that is associated with the registration. Type: String Required: Yes ResourceId The unique identiﬁer for the origination identity. For example this could be a PhoneNumberId or SenderId. Type: String Required: Yes ResourceType The origination identity type. Type: String Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: No RegistrationAssociationMetadata API Version 2022-03-31 468 AWS End User Messaging SMS PhoneNumber API Reference The phone number associated with the registration in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 469 AWS End User Messaging SMS API Reference RegistrationAttachmentFilter The ﬁlter deﬁnition for ﬁltering registration attachments that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: attachment-status Required: Yes Values An array of values to ﬁlter on. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationAttachmentFilter API Version 2022-03-31 470 AWS End User Messaging SMS API Reference RegistrationAttachmentsInformation Provides information on the speciﬁed registration attachments. Contents AttachmentStatus The status of the registration attachment. • UPLOAD_IN_PROGRESS The attachment is being uploaded. • UPLOAD_COMPLETE The attachment has been uploaded. • UPLOAD_FAILED The attachment failed to uploaded. • DELETED The attachment has been deleted.. Type: String Valid Values: UPLOAD_IN_PROGRESS \| UPLOAD_COMPLETE \| UPLOAD_FAILED \| DELETED Required: Yes CreatedTimestamp The time when the registration attachment was created, in UNIX epoch time format. Type: Timestamp Required: Yes RegistrationAttachmentArn The Amazon Resource Name (ARN) for the registration attachment. Type: String Required: Yes RegistrationAttachmentId The unique identiﬁer for the registration attachment. Type: String Required: Yes RegistrationAttachmentsInformation API Version 2022-03-31 471 AWS End User Messaging SMS AttachmentUploadErrorReason API Reference A description of why the upload didn't successfully complete. Type: String Valid Values: INTERNAL_ERROR Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 472 AWS End User Messaging SMS API Reference RegistrationDeniedReasonInformation Provides the reason a registration was rejected. Contents Reason The reason a registration was rejected. Type: String Required: Yes ShortDescription A short description of the rejection reason. Type: String Required: Yes DocumentationLink The link to the document. Type: String Required: No DocumentationTitle The title of the document. Type: String Required: No LongDescription A long description of the rejection reason. Type: String Required: No RegistrationDeniedReasonInformation API Version 2022-03-31 473 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 474 AWS End User Messaging SMS API Reference RegistrationFieldDeﬁnition Provides a description of the speciﬁed ﬁeld. Contents DisplayHints An array of RegistrationFieldDisplayHints objects for the ﬁeld. Type: RegistrationFieldDisplayHints object Required: Yes FieldPath The path to the registration form ﬁeld. You can use DescribeRegistrationFieldDeﬁnitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: Yes FieldRequirement Speciﬁes if the ﬁeld for the registration form is required, conditional or optional. Type: String Valid Values: REQUIRED \| CONDITIONAL
amazonpinpointsmsvoicev2-api-092	amazonpinpointsmsvoicev2-api.pdf	92	SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 474 AWS End User Messaging SMS API Reference RegistrationFieldDeﬁnition Provides a description of the speciﬁed ﬁeld. Contents DisplayHints An array of RegistrationFieldDisplayHints objects for the ﬁeld. Type: RegistrationFieldDisplayHints object Required: Yes FieldPath The path to the registration form ﬁeld. You can use DescribeRegistrationFieldDeﬁnitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: Yes FieldRequirement Speciﬁes if the ﬁeld for the registration form is required, conditional or optional. Type: String Valid Values: REQUIRED \| CONDITIONAL \| OPTIONAL Required: Yes FieldType The type of ﬁeld. Type: String Valid Values: SELECT \| TEXT \| ATTACHMENT RegistrationFieldDeﬁnition API Version 2022-03-31 475 AWS End User Messaging SMS Required: Yes SectionPath The section path of the ﬁeld. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. API Reference Pattern: [A-Za-z0-9_]+ Required: Yes SelectValidation The validation rules for a select ﬁeld. Type: SelectValidation object Required: No TextValidation The validation rules for a text ﬁeld. Type: TextValidation object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 476 AWS End User Messaging SMS API Reference RegistrationFieldDisplayHints Provides help information on the registration ﬁeld. Contents ShortDescription A short description of the display hint. Type: String Required: Yes Title The title of the display hint. Type: String Required: Yes DocumentationLink The link to the document the display hint is associated with. Type: String Required: No DocumentationTitle The title of the document the display hint is associated with. Type: String Required: No ExampleTextValue Example text of what the value of a ﬁeld should contain. Type: String Required: No RegistrationFieldDisplayHints API Version 2022-03-31 477 API Reference AWS End User Messaging SMS LongDescription A full description of the display hint. Type: String Required: No SelectOptionDescriptions An array of SelectOptionDescription objects. Type: Array of SelectOptionDescription objects Required: No TextValidationDescription The validation rules for the text ﬁeld. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 478 AWS End User Messaging SMS API Reference RegistrationFieldValueInformation Provides the values of the speciﬁed ﬁeld. Contents FieldPath The path to the registration form ﬁeld. You can use DescribeRegistrationFieldDeﬁnitions for a list of FieldPaths. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_\.]+ Required: Yes DeniedReason A description of why the registration was denied. Type: String Required: No RegistrationAttachmentId The unique identiﬁer for the registration attachment. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: No SelectChoices An array of values for the form ﬁeld. Type: Array of strings RegistrationFieldValueInformation API Version 2022-03-31 479 AWS End User Messaging SMS API Reference Array Members: Minimum number of 0 items. Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 256. Required: No TextValue The text data for a free form ﬁeld. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 480 AWS End User Messaging SMS RegistrationFilter API Reference The ﬁlter deﬁnition for ﬁltering registrations that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: registration-type \| registration-status Required: Yes Values An array of values to ﬁlter on. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationFilter API Version 2022-03-31 481 AWS End User Messaging SMS API Reference RegistrationInformation Provides information about the requested registration. Contents CreatedTimestamp The time when the registration was created, in UNIX epoch time format. Type: Timestamp Required: Yes CurrentVersionNumber The current version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Required: Yes RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String Required: Yes RegistrationId The unique identiﬁer for the registration. Type: String Required: Yes RegistrationStatus The status of
amazonpinpointsmsvoicev2-api-093	amazonpinpointsmsvoicev2-api.pdf	93	C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationFilter API Version 2022-03-31 481 AWS End User Messaging SMS API Reference RegistrationInformation Provides information about the requested registration. Contents CreatedTimestamp The time when the registration was created, in UNIX epoch time format. Type: Timestamp Required: Yes CurrentVersionNumber The current version number of the registration. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Required: Yes RegistrationArn The Amazon Resource Name (ARN) for the registration. Type: String Required: Yes RegistrationId The unique identiﬁer for the registration. Type: String Required: Yes RegistrationStatus The status of the registration. • CLOSED: The phone number or sender ID has been deleted and you must also delete the registration for the number. RegistrationInformation API Version 2022-03-31 482 AWS End User Messaging SMS API Reference • CREATED: Your registration is created but not submitted. • COMPLETE: Your registration has been approved and your origination identity has been created. • DELETED: The registration has been deleted. • PROVISIONING: Your registration has been approved and your origination identity is being created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REQUIRES_UPDATES: You must ﬁx your registration and resubmit it. • REVIEWING: Your registration has been accepted and is being reviewed. • SUBMITTED: Your registration has been submitted and is awaiting review. Type: String Valid Values: CREATED \| SUBMITTED \| REVIEWING \| REQUIRES_AUTHENTICATION \| PROVISIONING \| COMPLETE \| REQUIRES_UPDATES \| CLOSED \| DELETED Required: Yes RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDeﬁnitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes AdditionalAttributes Metadata about a given registration which is speciﬁc to that registration type. Type: String to string map Required: No ApprovedVersionNumber The version number of the registration that was approved. Contents API Version 2022-03-31 483 AWS End User Messaging SMS Type: Long API Reference Valid Range: Minimum value of 1. Maximum value of 100000. Required: No LatestDeniedVersionNumber The latest version number of the registration that was denied. Type: Long Valid Range: Minimum value of 1. Maximum value of 100000. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 484 AWS End User Messaging SMS API Reference RegistrationSectionDeﬁnition Provides information on the speciﬁed section deﬁnition. Contents DisplayHints The path to the section of the registration. Type: RegistrationSectionDisplayHints object Required: Yes SectionPath The path to the section of the registration. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: [A-Za-z0-9_]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationSectionDeﬁnition API Version 2022-03-31 485 AWS End User Messaging SMS API Reference RegistrationSectionDisplayHints Provides help information on the registration section. Contents ShortDescription A short description of the display hint. Type: String Required: Yes Title The title of the display hint. Type: String Required: Yes DocumentationLink The link to the document the display hint is associated with. Type: String Required: No DocumentationTitle The title of the document the display hint is associated with. Type: String Required: No LongDescription A full description of the display hint. Type: String Required: No RegistrationSectionDisplayHints API Version 2022-03-31 486 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 487 AWS End User Messaging SMS API Reference RegistrationTypeDeﬁnition Provides information on the supported registration type. Contents DisplayHints Provides help information on the registration. Type: RegistrationTypeDisplayHints object Required: Yes RegistrationType The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDeﬁnitions action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: [A-Za-z0-9_]+ Required: Yes SupportedAssociations The supported association behavior for the registration type. Type: Array of SupportedAssociation objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 RegistrationTypeDeﬁnition API Version 2022-03-31 488 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 489 AWS End User Messaging SMS API Reference RegistrationTypeDisplayHints Provides help information on the registration type. Contents Title The title of the display hint. Type: String Required: Yes DocumentationLink The link to the document the display hint is associated
amazonpinpointsmsvoicev2-api-094	amazonpinpointsmsvoicev2-api.pdf	94	type. Type: Array of SupportedAssociation objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 RegistrationTypeDeﬁnition API Version 2022-03-31 488 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 489 AWS End User Messaging SMS API Reference RegistrationTypeDisplayHints Provides help information on the registration type. Contents Title The title of the display hint. Type: String Required: Yes DocumentationLink The link to the document the display hint is associated with. Type: String Required: No DocumentationTitle The title of the document the display hint is associated with. Type: String Required: No LongDescription A full description of the display hint. Type: String Required: No ShortDescription A short description of the display hint. Type: String Required: No RegistrationTypeDisplayHints API Version 2022-03-31 490 AWS End User Messaging SMS See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 491 AWS End User Messaging SMS API Reference RegistrationTypeFilter The ﬁlter deﬁnition for ﬁltering registration types that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: supported-association-resource-type \| supported-association- iso-country-code Required: Yes Values An array of values to ﬁlter on. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationTypeFilter API Version 2022-03-31 492 AWS End User Messaging SMS API Reference RegistrationVersionFilter The ﬁlter deﬁnition for ﬁltering registration versions that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: registration-version-status Required: Yes Values An array of values to ﬁlter on. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegistrationVersionFilter API Version 2022-03-31 493 AWS End User Messaging SMS API Reference RegistrationVersionInformation Provides information about the speciﬁed version of the registration. Contents RegistrationVersionStatus The status of the registration. • APPROVED: Your registration has been approved. • ARCHIVED: Your previously approved registration version moves into this status when a more recently submitted version is approved. • DENIED: You must ﬁx your registration and resubmit it. • DISCARDED: You've abandon this version of their registration to start over with a new version. • DRAFT: The initial status of a registration version after it’s created. • REQUIRES_AUTHENTICATION: You need to complete email authentication. • REVIEWING: Your registration has been accepted and is being reviewed. • REVOKED: Your previously approved registration has been revoked. • SUBMITTED: Your registration has been submitted. Type: String Valid Values: DRAFT \| SUBMITTED \| REVIEWING \| REQUIRES_AUTHENTICATION \| APPROVED \| DISCARDED \| DENIED \| REVOKED \| ARCHIVED Required: Yes RegistrationVersionStatusHistory The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. Type: RegistrationVersionStatusHistory object Required: Yes VersionNumber The version number of the registration. RegistrationVersionInformation API Version 2022-03-31 494 AWS End User Messaging SMS Type: Long API Reference Valid Range: Minimum value of 1. Maximum value of 100000. Required: Yes DeniedReasons An array of RegistrationDeniedReasonInformation objects. Type: Array of RegistrationDeniedReasonInformation objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 495 AWS End User Messaging SMS API Reference RegistrationVersionStatusHistory The RegistrationVersionStatusHistory object contains the time stamps for when the reservations status changes. Contents DraftTimestamp The time when the registration was in the draft state, in UNIX epoch time format. Type: Timestamp Required: Yes ApprovedTimestamp The time when the registration was in the approved state, in UNIX epoch time format. Type: Timestamp Required: No ArchivedTimestamp The time when the registration was in the archived state, in UNIX epoch time format. Type: Timestamp Required: No DeniedTimestamp The time when the registration was in the denied state, in UNIX epoch time format. Type: Timestamp Required: No DiscardedTimestamp The time when the registration was in the discarded state,
amazonpinpointsmsvoicev2-api-095	amazonpinpointsmsvoicev2-api.pdf	95	time stamps for when the reservations status changes. Contents DraftTimestamp The time when the registration was in the draft state, in UNIX epoch time format. Type: Timestamp Required: Yes ApprovedTimestamp The time when the registration was in the approved state, in UNIX epoch time format. Type: Timestamp Required: No ArchivedTimestamp The time when the registration was in the archived state, in UNIX epoch time format. Type: Timestamp Required: No DeniedTimestamp The time when the registration was in the denied state, in UNIX epoch time format. Type: Timestamp Required: No DiscardedTimestamp The time when the registration was in the discarded state, in UNIX epoch time format. Type: Timestamp Required: No RegistrationVersionStatusHistory API Version 2022-03-31 496 AWS End User Messaging SMS API Reference RequiresAuthenticationTimestamp The time when the registration was in the requires authentication state, in UNIX epoch time format. Type: Timestamp Required: No ReviewingTimestamp The time when the registration was in the reviewing state, in UNIX epoch time format. Type: Timestamp Required: No RevokedTimestamp The time when the registration was in the revoked state, in UNIX epoch time format. Type: Timestamp Required: No SubmittedTimestamp The time when the registration was in the submitted state, in UNIX epoch time format. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 497 AWS End User Messaging SMS API Reference SelectOptionDescription A description of each select option. Contents Option The value of the option. Type: String Required: Yes Description A description of the option meaning. Type: String Required: No Title The title of the select option. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SelectOptionDescription API Version 2022-03-31 498 API Reference AWS End User Messaging SMS SelectValidation Validation rules for a select ﬁeld. Contents MaxChoices The maximum number of choices for the select. Type: Integer Required: Yes MinChoices The minimum number of choices for the select. Type: Integer Required: Yes Options An array of strings for the possible selection options. Type: Array of strings Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SelectValidation API Version 2022-03-31 499 AWS End User Messaging SMS API Reference SenderIdAndCountry The alphanumeric sender ID in a speciﬁc country that you want to describe. For more information on sender IDs see Requesting sender IDs in the AWS End User Messaging SMS User Guide. Contents IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes SenderId The unique identiﬁer of the sender. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: [A-Za-z0-9_:/-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SenderIdAndCountry API Version 2022-03-31 500 AWS End User Messaging SMS SenderIdFilter The information for a sender ID that meets a speciﬁed criteria. API Reference Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: sender-id \| iso-country-code \| message-type \| deletion- protection-enabled \| registered Required: Yes Values An array of values to ﬁlter for. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SenderIdFilter API Version 2022-03-31 501 AWS End User Messaging SMS API Reference SenderIdInformation The information for all SenderIds in an AWS account. Contents DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. Type: Boolean Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL \| PROMOTIONAL Required: Yes
amazonpinpointsmsvoicev2-api-096	amazonpinpointsmsvoicev2-api.pdf	96	AWS account. Contents DeletionProtectionEnabled By default this is set to false. When set to true the sender ID can't be deleted. Type: Boolean Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: Yes MessageTypes The type of message. Valid values are TRANSACTIONAL for messages that are critical or time- sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: TRANSACTIONAL \| PROMOTIONAL Required: Yes MonthlyLeasingPrice The monthly leasing price, in US dollars. Type: String SenderIdInformation API Version 2022-03-31 502 API Reference AWS End User Messaging SMS Required: Yes Registered True if the sender ID is registered. Type: Boolean Required: Yes SenderId The alphanumeric sender ID in a speciﬁc country that you'd like to describe. Type: String Length Constraints: Minimum length of 1. Maximum length of 11. Pattern: [A-Za-z0-9_-]+ Required: Yes SenderIdArn The Amazon Resource Name (ARN) associated with the SenderId. Type: String Required: Yes RegistrationId The unique identiﬁer for the registration. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2022-03-31 503 AWS End User Messaging SMS • AWS SDK for Ruby V3 API Reference See Also API Version 2022-03-31 504 AWS End User Messaging SMS SnsDestination API Reference An object that deﬁnes an Amazon SNS destination for events. You can use Amazon SNS to send notiﬁcation when certain events occur. Contents TopicArn The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:\S+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SnsDestination API Version 2022-03-31 505 AWS End User Messaging SMS SpendLimit API Reference Describes the current monthly spend limits for sending voice and text messages. For more information on increasing your monthly spend limit, see Requesting a spending quota increase in the AWS End User Messaging SMS User Guide. Contents EnforcedLimit The maximum amount of money, in US dollars, that you want to be able to spend sending messages each month. This value has to be less than or equal to the amount in MaxLimit. To use this custom limit, Overridden must be set to true. Type: Long Required: Yes MaxLimit The maximum amount of money that you are able to spend to send messages each month, in US dollars. Type: Long Required: Yes Name The name for the SpendLimit. Type: String Valid Values: TEXT_MESSAGE_MONTHLY_SPEND_LIMIT \| VOICE_MESSAGE_MONTHLY_SPEND_LIMIT \| MEDIA_MESSAGE_MONTHLY_SPEND_LIMIT Required: Yes Overridden When set to True, the value that has been speciﬁed in the EnforcedLimit is used to determine the maximum amount in US dollars that can be spent to send messages each month, in US dollars. SpendLimit API Version 2022-03-31 506 AWS End User Messaging SMS Type: Boolean Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 507 AWS End User Messaging SMS API Reference SupportedAssociation The processing rules for when a registration can be associated with an origination identity and disassociated from an origination identity. Contents AssociationBehavior The association behavior. • ASSOCIATE_BEFORE_SUBMIT The origination identity has to be supplied when creating a registration. • ASSOCIATE_ON_APPROVAL This applies to all sender ID registrations. The sender ID will be automatically provisioned once the registration is approved. • ASSOCIATE_AFTER_COMPLETE This applies to phone number registrations when you must complete a registration ﬁrst, then associate one or more phone numbers later. For example 10DLC campaigns and long codes. Type: String Valid Values: ASSOCIATE_BEFORE_SUBMIT \| ASSOCIATE_ON_APPROVAL \| ASSOCIATE_AFTER_COMPLETE Required: Yes DisassociationBehavior The disassociation behavior. • DISASSOCIATE_ALL_CLOSES_REGISTRATION All origination identities must be disassociated from the registration before the registration can be closed. • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted. • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated. Type: String Valid Values: DISASSOCIATE_ALL_CLOSES_REGISTRATION \| DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION \| DELETE_REGISTRATION_DISASSOCIATES SupportedAssociation API Version 2022-03-31 508 AWS End User Messaging SMS Required: Yes ResourceType API Reference Deﬁnes the behavior of when an origination identity and registration can be associated with each other. Type: String Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
amazonpinpointsmsvoicev2-api-097	amazonpinpointsmsvoicev2-api.pdf	97	be disassociated from the registration before the registration can be closed. • DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION All origination identities must be disassociated from the registration before the registration can be deleted. • DELETE_REGISTRATION_DISASSOCIATES The registration can be deleted and all origination identities will be disasscoiated. Type: String Valid Values: DISASSOCIATE_ALL_CLOSES_REGISTRATION \| DISASSOCIATE_ALL_ALLOWS_DELETE_REGISTRATION \| DELETE_REGISTRATION_DISASSOCIATES SupportedAssociation API Version 2022-03-31 508 AWS End User Messaging SMS Required: Yes ResourceType API Reference Deﬁnes the behavior of when an origination identity and registration can be associated with each other. Type: String Required: Yes IsoCountryCode The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. Type: String Length Constraints: Fixed length of 2. Pattern: [A-Z]{2} Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 509 AWS End User Messaging SMS API Reference Tag The list of tags to be added to the speciﬁed topic. Contents Key The key identiﬁer, or name, of the tag. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .+ Required: Yes Value The string value associated with the key of the tag. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: .* Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag API Version 2022-03-31 510 API Reference AWS End User Messaging SMS TextValidation Validation rules for a text ﬁeld. Contents MaxLength The maximum number of characters for the text ﬁeld. Type: Integer Required: Yes MinLength The minimum number of characters for the text ﬁeld. Type: Integer Required: Yes Pattern The regular expression used to validate the text ﬁeld. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TextValidation API Version 2022-03-31 511 AWS End User Messaging SMS API Reference ValidationExceptionField The ﬁeld associated with the validation exception. Contents Message The message associated with the validation exception with information to help determine its cause. Type: String Required: Yes Name The name of the ﬁeld. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2022-03-31 512 AWS End User Messaging SMS API Reference VeriﬁedDestinationNumberFilter The ﬁlter deﬁnition for ﬁltering veriﬁed destination phone numbers that meets a speciﬁed criteria. Contents Name The name of the attribute to ﬁlter on. Type: String Valid Values: status Required: Yes Values An array of values to ﬁlter on. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 20 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: [/\.:A-Za-z0-9+_-]+ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VeriﬁedDestinationNumberFilter API Version 2022-03-31 513 AWS End User Messaging SMS API Reference VeriﬁedDestinationNumberInformation Provides information about the requested veriﬁed destintion phone number. Contents CreatedTimestamp The time when the destination phone number was created, in UNIX epoch time format. Type: Timestamp Required: Yes DestinationPhoneNumber The veriﬁed destination phone number, in E.164 format. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: \+?[1-9][0-9]{1,18} Required: Yes Status The status of the veriﬁed destination phone number. • PENDING: The phone number hasn't been veriﬁed yet. • VERIFIED: The phone number is veriﬁed and can receive messages. Type: String Valid Values: PENDING \| VERIFIED Required: Yes VeriﬁedDestinationNumberArn The Amazon Resource Name (ARN) for the veriﬁed destination phone number. Type: String VeriﬁedDestinationNumberInformation API Version 2022-03-31 514 AWS End User Messaging SMS Required: Yes VeriﬁedDestinationNumberId The unique identiﬁer for the veriﬁed destination phone number. API Reference Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 515 AWS End User Messaging SMS API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4,
amazonpinpointsmsvoicev2-api-098	amazonpinpointsmsvoicev2-api.pdf	98	the veriﬁed destination phone number. API Reference Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2022-03-31 515 AWS End User Messaging SMS API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2022-03-31 516 AWS End User Messaging SMS API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2022-03-31 517 AWS End User Messaging SMS Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2022-03-31 518 AWS End User Messaging SMS API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 400 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 400 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 InvalidAction The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 400 InvalidClientTokenId The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 400 OptInRequired The AWS access key ID needs a subscription for the service. HTTP Status Code: 403 API Version 2022-03-31 519 AWS End User Messaging SMS RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy
amazonpinpointsmsvoicev2-api-099	amazonpinpointsmsvoicev2-api.pdf	99	Code: 403 API Version 2022-03-31 519 AWS End User Messaging SMS RequestExpired API Reference The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 API Version 2022-03-31 520
amazonq-developer-ug-001	amazonq-developer-ug.pdf	1	User Guide Amazon Q Developer Copyright © Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon Q Developer User Guide Amazon Q Developer: User Guide Copyright © Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon. Amazon Q Developer Table of Contents User Guide What is Amazon Q Developer? ....................................................................................................... 1 Get started ..................................................................................................................................................... 1 Amazon Q Developer pricing ..................................................................................................................... 3 Features ............................................................................................................................................ 4 Analytics ......................................................................................................................................................... 4 Summarizing your data ......................................................................................................................... 4 Management and governance ................................................................................................................... 4 Exploring nodes ....................................................................................................................................... 4 Investigating ............................................................................................................................................. 4 Taking inventory ...................................................................................................................................... 5 Use Amazon Q in the AWS Console Mobile Application ................................................................. 6 Diagnosing console errors ..................................................................................................................... 6 Compute ......................................................................................................................................................... 6 Choosing Amazon EC2 instances ......................................................................................................... 6 Databases ....................................................................................................................................................... 7 Writing database queries with natural language ............................................................................. 7 Networking and content delivery ............................................................................................................. 7 Analyzing network reachability ............................................................................................................ 7 Developer tools ............................................................................................................................................. 8 Developing code features ...................................................................................................................... 8 Getting inline code suggestions ........................................................................................................... 8 Chatting about code in IDEs ................................................................................................................. 8 Reviewing your code for security vulnerabilities and quality issues ............................................. 9 Transforming code .................................................................................................................................. 9 Generating unit tests .............................................................................................................................. 9 Developing software in Amazon CodeCatalyst ................................................................................. 9 Chatting about code in Amazon SageMaker AI Studio ................................................................. 10 Interacting with the command line and AWS CloudShell ............................................................ 10 Application integration ............................................................................................................................. 11 Writing scripts to automate AWS services ...................................................................................... 11 Writing ETL scripts and integrating data ......................................................................................... 11 Third-party integrations ........................................................................................................................... 12 Using GitLab Duo with Amazon Q .................................................................................................... 12 Using Amazon Q Developer features in GitHub ............................................................................. 12 iii Amazon Q Developer User Guide Cloud Financial Management .................................................................................................................. 12 Understanding your costs ................................................................................................................... 12 Customer support ...................................................................................................................................... 13 Getting customer support directly from Amazon Q ..................................................................... 13 Creating a support ticket .................................................................................................................... 13 Amazon Q in chat applications .......................................................................................................... 13 Getting started .............................................................................................................................. 14 Tiers of service ............................................................................................................................................ 14 Pro tier .......................................................................................................................................................... 15 Subscribing users .................................................................................................................................. 15 Managing subscriptions ....................................................................................................................... 32 Free tier ........................................................................................................................................................ 44 Upgrading to the Pro tier ................................................................................................................... 45 Free tier features .................................................................................................................................. 45 On AWS .......................................................................................................................................... 47 Authenticating to your Amazon Q Developer Pro subscription ....................................................... 47 Chatting about AWS .................................................................................................................................. 48 Add permissions .................................................................................................................................... 48 Working with Amazon Q on AWS websites .................................................................................... 49 Example questions ................................................................................................................................ 50 Chatting about your resources ........................................................................................................... 50 Asking Amazon Q to troubleshoot your resources ........................................................................ 53 Chatting about your costs .................................................................................................................. 56 Chatting about your telemetry and operations ............................................................................. 58 Using plugins ............................................................................................................................................... 58 CloudZero ............................................................................................................................................... 60 Datadog ................................................................................................................................................... 66 Wiz ............................................................................................................................................................ 73 Console-to-Code ......................................................................................................................................... 80 Console-to-Code .................................................................................................................................... 80 Where you can use Console-to-Code ............................................................................................... 81 Granting permissions ........................................................................................................................... 82 Using ........................................................................................................................................................ 82 Diagnosing console errors ........................................................................................................................ 84 Add permissions .................................................................................................................................... 84 Diagnose common errors in the console ......................................................................................... 85 iv Amazon Q Developer User Guide Chatting with Support .............................................................................................................................. 85 Prerequisites ........................................................................................................................................... 86 Specify the right service ..................................................................................................................... 86 Create a support case .......................................................................................................................... 86 Leave feedback ...................................................................................................................................... 89 In your IDE ..................................................................................................................................... 90 Supported IDEs ........................................................................................................................................... 90 Installing Amazon Q .................................................................................................................................. 92 Supported IDE versions ....................................................................................................................... 93 In Eclipse IDEs ....................................................................................................................................... 94 In JetBrains IDEs ................................................................................................................................... 95 In Visual Studio Code .......................................................................................................................... 96 In Visual Studio ..................................................................................................................................... 98 IAM principals in your AWS console ............................................................................................... 100 Chatting about code ............................................................................................................................... 100 Agentic coding .................................................................................................................................... 101 Using other natural languages ........................................................................................................ 101 Working with Amazon Q in your IDE ............................................................................................. 101 Example topics and questions ......................................................................................................... 103 Reporting issues with responses ..................................................................................................... 103 Explaining and updating code ......................................................................................................... 103 Chatting inline ..................................................................................................................................... 104 Adding context to the chat .............................................................................................................. 107 Managing conversations .................................................................................................................... 112 Generating inline suggestions ............................................................................................................... 114 Pausing suggestions ........................................................................................................................... 114 Amazon Q code completion in action ............................................................................................ 118 Suggestions in AWS coding environments .................................................................................... 125 Using shortcut keys ............................................................................................................................ 133 Using code references ....................................................................................................................... 139 Code examples .................................................................................................................................... 149 Transforming code (/transform) ........................................................................................................... 169 Transforming Java applications ....................................................................................................... 170 Transforming .NET applications ....................................................................................................... 206 Developing features (/dev) .................................................................................................................... 214 Develop features with /dev ............................................................................................................ 215 v Amazon Q Developer User Guide Best practices ...................................................................................................................................... 216 Example tasks ...................................................................................................................................... 216 Quotas ................................................................................................................................................... 217 Testing '/dev' suggestions ................................................................................................................ 218 Troubleshooting .................................................................................................................................. 226 Generating unit tests (/test) .................................................................................................................. 228 Prerequisites ........................................................................................................................................ 228 Generate unit tests with /test ......................................................................................................... 228 Usage and considerations ................................................................................................................. 230 Handling special cases ....................................................................................................................... 230 Reviewing code (/review) ....................................................................................................................... 231 Types of code issues .......................................................................................................................... 232 Quotas ................................................................................................................................................... 217 Starting a review ................................................................................................................................ 233 Understanding code issues ............................................................................................................... 236 Addressing code issues ...................................................................................................................... 238 Filtering code issues ........................................................................................................................... 241 Code issue severity ............................................................................................................................. 242 Generating
amazonq-developer-ug-002	amazonq-developer-ug.pdf	2	(/dev) .................................................................................................................... 214 Develop features with /dev ............................................................................................................ 215 v Amazon Q Developer User Guide Best practices ...................................................................................................................................... 216 Example tasks ...................................................................................................................................... 216 Quotas ................................................................................................................................................... 217 Testing '/dev' suggestions ................................................................................................................ 218 Troubleshooting .................................................................................................................................. 226 Generating unit tests (/test) .................................................................................................................. 228 Prerequisites ........................................................................................................................................ 228 Generate unit tests with /test ......................................................................................................... 228 Usage and considerations ................................................................................................................. 230 Handling special cases ....................................................................................................................... 230 Reviewing code (/review) ....................................................................................................................... 231 Types of code issues .......................................................................................................................... 232 Quotas ................................................................................................................................................... 217 Starting a review ................................................................................................................................ 233 Understanding code issues ............................................................................................................... 236 Addressing code issues ...................................................................................................................... 238 Filtering code issues ........................................................................................................................... 241 Code issue severity ............................................................................................................................. 242 Generating documentation (/doc) ....................................................................................................... 244 Use cases .............................................................................................................................................. 244 Supported ﬁle types .......................................................................................................................... 245 Quotas ................................................................................................................................................... 217 Generating a README ....................................................................................................................... 246 Best practices ...................................................................................................................................... 247 Supported languages .............................................................................................................................. 248 Inline suggestions ............................................................................................................................... 248 Chat and inline chat .......................................................................................................................... 249 Transformations .................................................................................................................................. 250 Feature development (/dev) ............................................................................................................ 251 Unit test generation (/test) .............................................................................................................. 251 Code reviews (/review) ...................................................................................................................... 251 Documentation generation (/doc) .................................................................................................. 252 Customizations .................................................................................................................................... 253 On your command line ............................................................................................................... 255 Supported environments ........................................................................................................................ 256 macOS ................................................................................................................................................... 256 vi Amazon Q Developer User Guide Linux ...................................................................................................................................................... 256 Windows ............................................................................................................................................... 256 Natural languages .............................................................................................................................. 257 Installing .................................................................................................................................................... 257 macOS ................................................................................................................................................... 257 Windows Subsystem for Linux (WSL) ............................................................................................. 259 Linux AppImage .................................................................................................................................. 260 Ubuntu .................................................................................................................................................. 260 With a zip ﬁle ...................................................................................................................................... 261 For remote use .................................................................................................................................... 265 Uninstalling .......................................................................................................................................... 266 Debugging ............................................................................................................................................ 267 Using chat .................................................................................................................................................. 268 Starting a chat session ...................................................................................................................... 268 Chat commands .................................................................................................................................. 268 Managing tool permissions .............................................................................................................. 269 Summarizing conversations .............................................................................................................. 273 Security considerations ..................................................................................................................... 274 Using MCP ................................................................................................................................................. 276 MCP overview ...................................................................................................................................... 277 Key beneﬁts ......................................................................................................................................... 278 MCP architecture ................................................................................................................................ 278 Core MCP concepts ............................................................................................................................ 279 MCP conﬁguration .............................................................................................................................. 280 MCP tools and prompts .................................................................................................................... 282 MCP security ........................................................................................................................................ 284 Using the editor command .................................................................................................................... 285 Basic usage ........................................................................................................................................... 285 Setting your preferred editor ........................................................................................................... 285 How it works ....................................................................................................................................... 286 Working with code in the editor ..................................................................................................... 287 Combining with other commands .................................................................................................. 287 Best practices for command combinations ................................................................................... 290 Tips for eﬀective use ......................................................................................................................... 290 Troubleshooting .................................................................................................................................. 291 Context management ............................................................................................................................. 291 vii Amazon Q Developer User Guide Understanding proﬁles and context ............................................................................................... 291 Managing proﬁles ............................................................................................................................... 292 Managing context ............................................................................................................................... 292 Common use cases ............................................................................................................................. 294 Context hooks ........................................................................................................................................... 296 Types of context hooks ..................................................................................................................... 296 Managing context hooks ................................................................................................................... 296 Example use cases .............................................................................................................................. 298 Behavior and limitations ................................................................................................................... 299 Security considerations ..................................................................................................................... 299 Troubleshooting .................................................................................................................................. 300 Settings ...................................................................................................................................................... 300 Accessing settings ............................................................................................................................... 300 Command line settings management ............................................................................................ 301 Autocomplete and inline suggestions ............................................................................................ 302 Other Amazon Q CLI commands .................................................................................................... 302 Log ﬁles ................................................................................................................................................ 303 Autocomplete ........................................................................................................................................... 304 Using Amazon Q autocomplete ...................................................................................................... 304 Using autocomplete over SSH ......................................................................................................... 304 Inline ...................................................................................................................................................... 305 Supported tools .................................................................................................................................. 305 Translating ............................................................................................................................................ 306 Conﬁguring autocomplete behavior ............................................................................................... 306 Contributing .............................................................................................................................................. 307 GitHub repository ............................................................................................................................... 307 Reporting issues .................................................................................................................................. 307 Providing feedback ............................................................................................................................. 308 RFCs ....................................................................................................................................................... 308 Telemetry data .................................................................................................................................... 309 Third-party integration ............................................................................................................... 310 GitLab Duo with Amazon Q .................................................................................................................. 310 GitHub with Amazon Q (preview) ........................................................................................................ 310 GitLab Duo ................................................................................................................................................ 311 GitLab Duo concepts .......................................................................................................................... 311 Getting started .................................................................................................................................... 316 viii Amazon Q Developer User Guide Customizing a CI/CD pipeline .......................................................................................................... 317 Troubleshooting .................................................................................................................................. 320 GitHub (Preview) ...................................................................................................................................... 321 Installing Amazon Q Developer app and authorizing access ..................................................... 322 Amazon Q Developer agents ........................................................................................................... 323 Registering app installation ............................................................................................................. 324 Using browser extensions in GitHub .............................................................................................. 324 Quickstart ............................................................................................................................................. 324 Developing features and iterating .................................................................................................. 327 Reviewing code ................................................................................................................................... 329 Transforming code ............................................................................................................................. 331 Customizing a workﬂow ................................................................................................................... 333 Increase usage limits and conﬁguration ........................................................................................ 335 Conﬁguring .......................................................................................................................................... 337 In chat applications ..................................................................................................................... 340 Enable Amazon Q chat in your channels ............................................................................................ 340 Ask Amazon Q questions in your channel .......................................................................................... 341 Customizing ................................................................................................................................. 342 Preparing .................................................................................................................................................... 343 Authorizing ........................................................................................................................................... 343 Preparing your data ........................................................................................................................... 343 Creating ...................................................................................................................................................... 344 Connecting to your data source ...................................................................................................... 345 Customizations and your data ......................................................................................................... 347 Troubleshooting .................................................................................................................................. 347 Deleting ...................................................................................................................................................... 348 Optimizing ................................................................................................................................................. 348 Optimizing ............................................................................................................................................ 349 Troubleshooting ....................................................................................................................................... 349 Setting up log delivery ..................................................................................................................... 349 Understanding Amazon CloudWatch Logs .................................................................................... 350 Understanding console error messages ......................................................................................... 352 Activating ................................................................................................................................................... 354 Activating a version ........................................................................................................................... 354 Updating .................................................................................................................................................... 355 Creating a new version ...................................................................................................................... 355 ix Amazon Q Developer User Guide Adding users and groups ....................................................................................................................... 356 Using ........................................................................................................................................................... 357 Security ........................................................................................................................................ 360 Data protection ........................................................................................................................................ 361 Data encryption .................................................................................................................................. 362 Service improvement ......................................................................................................................... 364 Opt out of data sharing in the IDE ................................................................................................ 365 Cross-region processing .................................................................................................................... 372 Identity and access management ......................................................................................................... 375 Audience ............................................................................................................................................... 375 Authenticating with identities ......................................................................................................... 376 Managing access using policies ....................................................................................................... 379 How Amazon Q works with IAM ..................................................................................................... 381 Manage access to Amazon Q ........................................................................................................... 388 Manage access to Amazon Q Developer for integration ............................................................ 423 Amazon Q permissions reference ................................................................................................... 424 AWS managed policies for
amazonq-developer-ug-003	amazonq-developer-ug.pdf	3	355 ix Amazon Q Developer User Guide Adding users and groups ....................................................................................................................... 356 Using ........................................................................................................................................................... 357 Security ........................................................................................................................................ 360 Data protection ........................................................................................................................................ 361 Data encryption .................................................................................................................................. 362 Service improvement ......................................................................................................................... 364 Opt out of data sharing in the IDE ................................................................................................ 365 Cross-region processing .................................................................................................................... 372 Identity and access management ......................................................................................................... 375 Audience ............................................................................................................................................... 375 Authenticating with identities ......................................................................................................... 376 Managing access using policies ....................................................................................................... 379 How Amazon Q works with IAM ..................................................................................................... 381 Manage access to Amazon Q ........................................................................................................... 388 Manage access to Amazon Q Developer for integration ............................................................ 423 Amazon Q permissions reference ................................................................................................... 424 AWS managed policies for Amazon Q ........................................................................................... 427 Using service-linked roles ................................................................................................................. 437 Compliance validation ............................................................................................................................ 445 Resilience ................................................................................................................................................... 446 Infrastructure security ............................................................................................................................. 446 Firewalls, proxies, and data perimeters ............................................................................................... 447 General URLs to allowlist ................................................................................................................. 447 Amazon S3 bucket URLs and ARNs to allowlist ........................................................................... 448 VPC endpoints (AWS PrivateLink) ........................................................................................................ 449 Considerations for Amazon Q VPC endpoints .............................................................................. 450 Prerequisites ........................................................................................................................................ 450 Creating an interface VPC endpoint for Amazon Q .................................................................... 450 Using an on-premises computer to connect to a Amazon Q endpoint ................................... 451 Using an in-console coding environment to connect to a Amazon Q endpoint .................... 451 Connecting to Amazon Q through AWS PrivateLink from a third-Party IDE on an Amazon EC2 instance ........................................................................................................................................ 452 Monitoring and tracking ............................................................................................................. 453 With AWS CloudTrail ............................................................................................................................... 453 Amazon Q Developer information in CloudTrail .......................................................................... 454 Understanding Amazon Q Developer log ﬁle entries ................................................................. 455 x Amazon Q Developer User Guide With CloudWatch ..................................................................................................................................... 459 Identifying actions by speciﬁc users .............................................................................................. 461 Accessing customization-related logs ............................................................................................ 477 Viewing usage metrics (dashboard) ..................................................................................................... 478 Dashboard metrics ............................................................................................................................. 480 Disabling the dashboard ................................................................................................................... 484 Troubleshooting the dashboard ...................................................................................................... 484 Viewing per-user activity ....................................................................................................................... 485 User activity report metrics .............................................................................................................. 488 Logging users' prompts .......................................................................................................................... 493 Prompt log examples ........................................................................................................................ 496 Supported Regions ...................................................................................................................... 507 Supported Regions (enabled by default) ............................................................................................ 507 Supported opt-in Regions ...................................................................................................................... 508 Amazon Q Developer service rename ........................................................................................ 510 Document history ........................................................................................................................ 511 xi Amazon Q Developer User Guide What is Amazon Q Developer? Note Powered by Amazon Bedrock: Amazon Q Developer is built on Amazon Bedrock and includes automated abuse detection implemented in Amazon Bedrock to enforce safety, security, and the responsible use of AI. Amazon Q Developer is a generative artiﬁcial intelligence (AI) powered conversational assistant that can help you understand, build, extend, and operate AWS applications. You can ask questions about AWS architecture, your AWS resources, best practices, documentation, support, and more. Amazon Q is constantly updating its capabilities so your questions get the most contextually relevant and actionable answers. When used in an integrated development environment (IDE), Amazon Q provides software development assistance. Amazon Q can chat about code, provide inline code completions, generate net new code, scan your code for security vulnerabilities, and make code upgrades and improvements, such as language updates, debugging, and optimizations. Amazon Q is powered by Amazon Bedrock, a fully managed service that makes foundation models (FMs) available through an API. The model that powers Amazon Q has been augmented with high quality AWS content to get you more complete, actionable, and referenced answers to accelerate your building on AWS. Note This is the documentation for Amazon Q Developer. If you are looking for documentation for Amazon Q Business, see the Amazon Q Business User Guide. Get started with Amazon Q Developer To quickly get started using Amazon Q, you can access it in the following ways: Get started 1 Amazon Q Developer AWS apps and websites User Guide Add the necessary permissions to your IAM identity, and then choose the Amazon Q icon to start chatting in the AWS Management Console, AWS Documentation website, AWS website, or AWS Console Mobile Application. For more information, see Using Amazon Q Developer on AWS apps and websites. IDEs Download the Amazon Q extension and use your AWS Builder ID (no AWS account required) to sign in for free. Download Amazon Q in Visual Studio Code Download Amazon Q in JetBrains IDEs Download Amazon Q in the AWS Toolkit for Visual Studio Download Amazon Q in Eclipse IDEs (Preview) From your IDE, choose the Amazon Q icon to start chatting or initiate a development workﬂow. For more information, see Installing the Amazon Q Developer extension or plugin in your IDE. Command line Download Amazon Q for command line for macOS Download Amazon Q for command line for Linux AppImage Get started 2 Amazon Q Developer User Guide Download Amazon Q for command line for Ubuntu For more information, see Using Amazon Q Developer on the command line. Amazon Q Developer in chat applications Add the AmazonQDeveloperAccess managed policy to your IAM identity and channel guardrails for Microsoft Teams or Slack applications. For more information, see Chatting with Amazon Q Developer in chat applications. Amazon Q
amazonq-developer-ug-004	amazonq-developer-ug.pdf	4	For more information, see Installing the Amazon Q Developer extension or plugin in your IDE. Command line Download Amazon Q for command line for macOS Download Amazon Q for command line for Linux AppImage Get started 2 Amazon Q Developer User Guide Download Amazon Q for command line for Ubuntu For more information, see Using Amazon Q Developer on the command line. Amazon Q Developer in chat applications Add the AmazonQDeveloperAccess managed policy to your IAM identity and channel guardrails for Microsoft Teams or Slack applications. For more information, see Chatting with Amazon Q Developer in chat applications. Amazon Q Developer pricing Amazon Q Developer is available through a Free tier and the Amazon Q Developer Pro subscription. For more information, see Amazon Q Developer pricing. Amazon Q Developer pricing 3 Amazon Q Developer User Guide Amazon Q Developer features Amazon Q Developer is available across AWS environments and services, and also as a coding assistant in third party IDEs. Many of Amazon Q Developer’s capabilities exist in a chat interface, where you can use natural language to ask questions about AWS, get help with code, explore resources, or troubleshoot. When you chat with Amazon Q, Amazon Q uses the context of your current conversation to inform its responses. You can ask follow-up questions or refer to its response when you ask a new question. Other Amazon Q Developer features are available as a part of your workﬂows in AWS service consoles and supported IDEs. The following sections explain the diﬀerent features of Amazon Q Developer that you might encounter across your AWS experience. Analytics Summarizing your data With Amazon Q QuickSight, you can utilize the Generative BI authoring experience, create executive summaries of your data, ask and answer questions of data, and generate data stories. For more information, see Using Generative BI with Amazon Q QuickSight in the QuickSight User Guide. Management and governance Exploring nodes using text prompts Using AWS Systems Manager and Amazon Q, you can ask natural language questions about your managed nodes or instances. Amazon Q then uses the Systems Manager ListNodes action and creates ﬁlters based on your textual input to retrieve results. For more information, see Exploring nodes using text prompts in Amazon Q in the AWS Systems Manager User Guide. Analytics 4 Amazon Q Developer User Guide Investigating operational issues (preview) Amazon Q Developer operational investigations enhance your ability to investigate and analyze resources, events, and activities across your AWS environment. By leveraging natural language processing, Amazon Q simpliﬁes the process of understanding complex scenarios and relationships within your AWS account. Amazon Q Developer now helps you accelerate operational investigations across your AWS environment. Q looks for anomalies in your telemetry, surfaces related signals for you to explore, identiﬁes potential root-cause hypothesis, and suggests next steps to help you remediate issues faster. By integrating Amazon Q into your investigative workﬂows, you can accelerate problem solving, enhance your understanding of your AWS environment, and make more informed decisions about your infrastructure and applications. Note The Amazon Q operational investigations feature is in preview release and is subject to change. For example questions to ask Amazon Q in the context of operational investigations, see Chatting about your telemetry and operations. For more information about Amazon Q operational investigations in general, see Amazon Q Developer operational investigations in the Amazon CloudWatch User Guide. Taking inventory of your AWS resources You can ask Amazon Q about your speciﬁc AWS account resources from anywhere in the AWS Management Console. You might not know where to locate relevant information about your resources, or you might be in one service console and want to access information about another service’s resources without disrupting your workﬂow. Amazon Q Developer answers your natural language questions about resources and provides deep links to those resources so you can quickly ﬁnd them. You can ask Amazon Q to list a type of resource in your account, for details about a speciﬁc resource, or to list resources based on a criteria such as region or state. Investigating 5 Amazon Q Developer User Guide For example, you may want to know how many Amazon EC2 instances you currently have running. In that case, you can ask Amazon Q your question in natural language, and it will provide an answer based on your speciﬁc resources. For more information, see Chatting about your resources with Amazon Q Developer. For information about speciﬁc limits for each type, and how they relate to pricing for speciﬁc subscription package, see Amazon Q Developer pricing. Use Amazon Q in the AWS Console Mobile Application Amazon Q is integrated with the AWS Console Mobile Application to answer questions about AWS. You conﬁgure access the same way that you get access to Amazon Q in the AWS Management Console. For more information, see Getting
amazonq-developer-ug-005	amazonq-developer-ug.pdf	5	Amazon Q your question in natural language, and it will provide an answer based on your speciﬁc resources. For more information, see Chatting about your resources with Amazon Q Developer. For information about speciﬁc limits for each type, and how they relate to pricing for speciﬁc subscription package, see Amazon Q Developer pricing. Use Amazon Q in the AWS Console Mobile Application Amazon Q is integrated with the AWS Console Mobile Application to answer questions about AWS. You conﬁgure access the same way that you get access to Amazon Q in the AWS Management Console. For more information, see Getting started with Amazon Q Developer. Diagnosing console errors In the AWS Management Console, Amazon Q Developer can diagnose common errors you receive while working with AWS services, such as insuﬃcient permissions, incorrect conﬁguration, and exceeding service limits. For more information, see Diagnosing common errors in the console with Amazon Q Developer. Compute Choosing Amazon Elastic Compute Cloud instances With so many Amazon EC2 instance types available, ﬁnding the right instance types for your workload can be time-consuming and complex. The Amazon Q instance type selector considers your use case, workload type, CPU manufacturer preference, and how you prioritize price and performance, as well as additional parameters that you can specify. It then uses this data to provide suggestions and guidance for Amazon EC2 instance types that are best suited to your new workloads. For more information, see Get recommendations from Amazon EC2 instance type ﬁnder in the Amazon Elastic Compute Cloud User Guide. Use Amazon Q in the AWS Console Mobile Application 6 Amazon Q Developer User Guide Databases Writing database queries with natural language Amazon Q generative SQL uses generative AI to analyze user intent, query patterns, and schema metadata to identify common SQL query patterns directly within Amazon Redshift, accelerating the query authoring process for users and reducing the time required to derive actionable data insights. For more information, see Interacting with Amazon Q generative SQL in the Amazon Redshift Management Guide. Networking and content delivery Analyzing network troubleshooting You can use Amazon Q to help you diagnose network connectivity issues for applications that run in your Amazon VPCs. Amazon Q network troubleshooting can understand natural language Databases 7 Amazon Q Developer User Guide queries, and works with Reachability Analyzer to provide relevant responses. With Amazon Q, you can ask network reachability questions in a conversational format. For more information, see Amazon Q network troubleshooting for Reachability Analyzer in the Amazon VPC Reachability Analyzer Guide. Developer tools Ask Amazon Q Developer questions about building at AWS and for assistance with software development. Amazon Q can explain coding concepts and code snippets, generate code and unit tests, and improve code, including debugging or refactoring. Developing code features After you explain, in natural language, the feature that you want to develop, Amazon Q can use the context of your current project to generate an implementation plan and the accompanying code. Amazon Q can help you build AWS projects or your own applications. For more information, see Developing features with Amazon Q Developer. Getting inline code suggestions Amazon Q provides you with code recommendations in real time. As you write code, Amazon Q automatically generates suggestions based on your existing code and comments. For more information, see Generating inline suggestions with Amazon Q Developer. Chatting about code in IDEs Within integrated development environments (IDEs), Amazon Q can answer questions related to the software development process, including conceptual questions about programming and how speciﬁc code works. You can also ask Amazon Q to update and improve code snippets from the chat panel. With multi-language support, you can chat with Amazon Q in any of the supported natural languages, including English, Mandarin, French, German, Italian, Japanese, Spanish, Korean, Hindi and Portuguese, with more languages available. For more information, see Chatting with Amazon Q Developer about code. To write code and get development assistance in the most full-featured environment with Amazon Q Developer, see Using Amazon Q Developer in the IDE. To enable basic code completion functionality in other interfaces across AWS, see Generating inline suggestions in AWS coding environments. Developer tools 8 Amazon Q Developer User Guide Reviewing your code for security vulnerabilities and quality issues Within IDEs, Amazon Q reviews your code for security vulnerabilities and code quality issues. Amazon Q can review as you code or review entire projects to monitor the security and quality of your applications throughout development. For more information, see Reviewing code with Amazon Q Developer. Transforming code Amazon Q can perform automated language and operating system (OS)-level upgrades for your applications. For more information, see Transforming code in the IDE with Amazon Q Developer . Generating unit tests Amazon Q Developer provides an AI-powered unit test generation feature to help development teams improve code coverage throughout
amazonq-developer-ug-006	amazonq-developer-ug.pdf	6	and quality issues Within IDEs, Amazon Q reviews your code for security vulnerabilities and code quality issues. Amazon Q can review as you code or review entire projects to monitor the security and quality of your applications throughout development. For more information, see Reviewing code with Amazon Q Developer. Transforming code Amazon Q can perform automated language and operating system (OS)-level upgrades for your applications. For more information, see Transforming code in the IDE with Amazon Q Developer . Generating unit tests Amazon Q Developer provides an AI-powered unit test generation feature to help development teams improve code coverage throughout their software development lifecycle. The Amazon Q Developer agent for unit test generation is available in the following environments: • Amazon Q Developer IDE extension. For more information, see Generating unit tests with Amazon Q. • GitLab, as part of GitLab Duo. For more information, see the section called “GitLab quick actions”. Note The unit test generation capability is available in all Amazon Q Developer supported regions. Developing software in Amazon CodeCatalyst Amazon Q Developer in CodeCatalyst includes generative AI features that can help users in projects in your space develop software faster. You can assign issues to Amazon Q or recommend tasks for Amazon Q. You can also ask Amazon Q to write a description or to summarize content. For more information, see Managing generative AI features in Amazon CodeCatalyst in the Amazon CodeCatalyst administrator guide. Reviewing your code for security vulnerabilities and quality issues 9 Amazon Q Developer User Guide Chatting about code in Amazon SageMaker AI Studio Amazon SageMaker AI Studio is a web-based experience for running ML workﬂows. You can chat with Amazon Q Developer inside Studio to get guidance on SageMaker AI features, troubleshoot JupyterLab errors, and get sample code. For more information, see Use Amazon Q to Expedite Your Machine Learning Workﬂows in the SageMaker AI Developer Guide. Interacting with the command line and AWS CloudShell Command Line Interface (CLI) After installing Amazon Q for the command line, you can use it to complete CLI commands as it populates contextually relevant subcommands, options and arguments. It provides AI-generated completions as you type in the command line. Additionally, you can use Amazon Q to write natural language instructions that are instantly translated to an executable shell code snippet. You can also ask Amazon Q complex questions, and it provides feedback and instructions based on the conversation, as well as context and information outside of the conversation. You can then provide permission to Amazon Q so it performs actions on your behalf. With multi-language support, you can chat with Amazon Q in any of the supported natural languages, including English, Mandarin, French, German, Italian, Japanese, Spanish, Korean, Hindi and Portuguese, with more languages available. For more information, see Using Amazon Q Developer on the command line. AWS CloudShell You can also use Amazon Q CLI in AWS CloudShell to interact in natural language conversations, ask questions, and receive responses from Amazon Q in your terminal. You can get the related Chatting about code in Amazon SageMaker AI Studio 10 Amazon Q Developer User Guide shell command that reduces the need to search for or remember syntax. With Amazon Q, you can receive command suggestions as you type in the terminal. For more information, see Using Amazon Q AWS CLI in AWS CloudShell. Application integration Writing scripts to automate AWS services You may know exactly what to do with your AWS resources, and you may ﬁnd yourself taking the same actions repeatedly. In that case, you can ask Amazon Q to write code that will automate the repetitive tasks. For example, you may be working on a project that uses Amazon VPCs, Amazon EC2 instances, and Amazon RDS databases. In the course of your testing, you ﬁnd that every time you create a Amazon VPC, spin up a server, and deploy a database, the conﬁguration is the same. You always choose the same instance and database type, with the same options selected, using the same security groups, in subnets with the same NACL conﬁguration. You don’t want to have to go through the same manual process every time you want to re-create your test conditions. You can use Amazon Q’s Console-to-Code feature to automate a workﬂow instead of performing it manually every time. First, you activate Console-to-Code in the Amazon EC2 console. Then, Amazon Q records your actions as you go through the process of conﬁguring and launching your instance. Finally, Amazon Q provides you with code, in a language of your choice, that automates the process you just performed. For more information, see Automating AWS services with Amazon Q Developer Console-to-Code. Writing ETL scripts and integrating data AWS Glue is a serverless data integration service that makes it easy for analytics users to discover, prepare, move,
amazonq-developer-ug-007	amazonq-developer-ug.pdf	7	use Amazon Q’s Console-to-Code feature to automate a workﬂow instead of performing it manually every time. First, you activate Console-to-Code in the Amazon EC2 console. Then, Amazon Q records your actions as you go through the process of conﬁguring and launching your instance. Finally, Amazon Q provides you with code, in a language of your choice, that automates the process you just performed. For more information, see Automating AWS services with Amazon Q Developer Console-to-Code. Writing ETL scripts and integrating data AWS Glue is a serverless data integration service that makes it easy for analytics users to discover, prepare, move, and integrate data from multiple sources. Amazon Q data integration in AWS Glue includes the following capabilities: • Chat – Amazon Q data integration in AWS Glue can answer natural language questions in English about AWS Glue and data integration domains like AWS Glue source and destination connectors, AWS Glue ETL jobs, Data Catalog, crawlers and AWS Lake Formation, and other feature documentation, and best practices. Amazon Q data integration in AWS Glue responds with step-by-step instructions, and includes references to its information sources. Application integration 11 Amazon Q Developer User Guide • Data integration code generation – Amazon Q data integration in AWS Glue can answer questions about AWS Glue ETL scripts, and generate new code given a natural language question in English. • Troubleshoot – Amazon Q data integration in AWS Glue is purpose built to help you understand errors in AWS Glue jobs and provides step-by-step instructions, to root cause and resolve your issues. For more information, see Amazon Q data integration in AWS Glue in the AWS Glue User Guide. Third-party integrations Using GitLab Duo with Amazon Q You can GitLab Duo with Amazon Q for your software development operations and source code management workﬂows. After setting up Amazon Q in GitLab Duo, you can invoke quick actions to automate tasks, including implement code for your ideas, transform your codebase, review merge requests for quality and vulnerabilities, and suggest unit tests. For more information, see GitLab Duo with Amazon Q. Using Amazon Q Developer features in GitHub You can leverage Amazon Q Developer capabilities for your software development workﬂows. With specialized development agents, you can implement new ideas, review code for quality issues, address vulnerabilities with unit tests, and modernize legacy Java applications. For more information, see Amazon Q Developer for GitHub (Preview). Cloud Financial Management Understanding your costs You can ask Amazon Q about your AWS bill and account costs in the AWS Management Console. Amazon Q can retrieve your cost data, explain costs, and analyze cost trends. For more information, see Chatting about your costs. Third-party integrations 12 Amazon Q Developer Customer support User Guide Getting customer support directly from Amazon Q Amazon Q can answer your questions about account activation, cost spikes, bill adjustment, fraud events, health events, and issues with your AWS resources. For more information, see Chatting about your costs, and Asking Amazon Q to troubleshoot your resources. Creating a support ticket Amazon Q can help you create a support case and then connect you to a human support agent at AWS. For more information, see Using Amazon Q Developer to chat with Support. Amazon Q in chat applications You can activate Amazon Q in your Slack and Microsoft Teams applications to ask questions about building at AWS. To add Amazon Q to your chat applications, see Chatting with Amazon Q Developer in chat applications. For more information, see Get started with Slack and Get started with Microsoft Teams in the Amazon Q Developer in chat applications Administrator Guide. Customer support 13 Amazon Q Developer User Guide Getting started with Amazon Q Developer The following topics describe how to set up Amazon Q Developer Pro for workforce users in your organization, and how individual users can access the Amazon Q Developer Free tier. Topics • Understanding tiers of service for Amazon Q Developer • Amazon Q Developer Pro tier • Amazon Q Developer Free tier Understanding tiers of service for Amazon Q Developer When you use Amazon Q Developer, you either use Amazon Q Developer Pro, which is a paid subscription service, or you use Amazon Q Developer at the Free tier. Review the following information to understand what's oﬀered at each tier. • Amazon Q Developer Pro tier – The Pro tier is a paid version of the Amazon Q Developer service. This gives you access to advanced features, such as customization, as well as higher usage limits. To use Amazon Q Developer Pro, you must be a user in IAM Identity Center, and your administrator must subscribe you to Amazon Q Developer Pro. For more information, see Amazon Q Developer Pro tier. • Amazon Q Developer Free tier – Amazon Q Developer oﬀers a perpetual Free tier with monthly
amazonq-developer-ug-008	amazonq-developer-ug.pdf	8	tier. Review the following information to understand what's oﬀered at each tier. • Amazon Q Developer Pro tier – The Pro tier is a paid version of the Amazon Q Developer service. This gives you access to advanced features, such as customization, as well as higher usage limits. To use Amazon Q Developer Pro, you must be a user in IAM Identity Center, and your administrator must subscribe you to Amazon Q Developer Pro. For more information, see Amazon Q Developer Pro tier. • Amazon Q Developer Free tier – Amazon Q Developer oﬀers a perpetual Free tier with monthly limits, including for users authenticating with AWS Builder ID. The features available to you depends on your interface and on how you authenticate. For more information on authentication and access at the Free tier, see Amazon Q Developer Free tier. For more information about pricing tiers and feature availability, see the Amazon Q Developer pricing page. For more information on how content is used to improve the service at the Free tier, see Amazon Q Developer service improvement. Tiers of service 14 Amazon Q Developer User Guide Amazon Q Developer Pro tier With a paid subscription to the Amazon Q Developer Pro tier, your workforce users can access all features of Amazon Q Developer, including ML-assisted software development in your IDE and chatting with Amazon Q in the AWS Management Console without hard monthly limits. This section describes how to set up and manage Amazon Q Developer Pro tier subscriptions. For more information on what you can access with the Pro tier, see the Amazon Q Developer pricing page. Topics • Subscribing users to Amazon Q Developer Pro • Managing Amazon Q Developer Pro subscriptions Subscribing users to Amazon Q Developer Pro To subscribe users to Amazon Q Developer Pro, you have three options depending on the type of AWS account you have: • If you have a standalone account, see Subscribe users in a standalone account. Use these instructions if you want to quickly evaluate the features of Amazon Q. • If you have a management account in AWS Organizations, see Subscribe users to Amazon Q Developer Pro in a management account. • If you have a member account in AWS Organizations, see Subscribe users to Amazon Q Developer Pro in a member account. Regardless of the type of account you have, you might need to work across multiple AWS Regions and AWS accounts to subscribe users. For more information, see Subscribe users to Amazon Q Developer Pro across AWS Regions and Subscribe users to Amazon Q Developer Pro across accounts. Not sure what member and management accounts are? See Terminology and concepts for AWS Organizations in the AWS Organizations User Guide for explanations. For general information about AWS Organizations, see What is AWS Organizations? in the AWS Organizations User Guide. Pro tier 15 Amazon Q Developer Topics User Guide • Subscribe users in a standalone account • Subscribe users to Amazon Q Developer Pro in a management account • Subscribe users to Amazon Q Developer Pro in a member account • Subscribe users to Amazon Q Developer Pro across accounts • Subscribe users to Amazon Q Developer Pro across AWS Regions Subscribe users in a standalone account A standalone account is one that is not part of an organization managed by AWS Organizations. If you are the owner of a standalone AWS account, use the following instructions to subscribe yourself (and a few others) to Amazon Q Developer Pro to evaluate the service’s features and functionality. After completing the steps on this page, read What resources were created? at the end to understand which resources were installed and conﬁgured on your behalf when you subscribed. This will help you cleanly remove everything when you're ﬁnished testing. Prerequisites Before you begin, make sure that: • You have a standalone AWS account. • You have the minimum permissions required to subscribe users and manage Amazon Q Developer settings. For more information, see Allow administrators to use the Amazon Q console, and Allow administrators to use the Amazon Q Developer console. • (Optional) You have an account instance of IAM Identity Center set up in your standalone account. This IAM Identity Center contains the users you want to subscribe to Amazon Q Developer Pro, and must be deployed in a supported AWS Region, as described in Supported Regions for IAM Identity Center. If you don't have an IAM Identity Center instance installed, that's ok. One will be installed when you subscribe the ﬁrst user (yourself). For more information about IAM Identity Center, see Organization and account instances of IAM Identity Center. Subscribing users 16 Amazon Q Developer Note User Guide The instructions on this page assume you have not already installed an IAM Identity Center instance in your standalone account. Step
amazonq-developer-ug-009	amazonq-developer-ug.pdf	9	Center contains the users you want to subscribe to Amazon Q Developer Pro, and must be deployed in a supported AWS Region, as described in Supported Regions for IAM Identity Center. If you don't have an IAM Identity Center instance installed, that's ok. One will be installed when you subscribe the ﬁrst user (yourself). For more information about IAM Identity Center, see Organization and account instances of IAM Identity Center. Subscribing users 16 Amazon Q Developer Note User Guide The instructions on this page assume you have not already installed an IAM Identity Center instance in your standalone account. Step 1: Install the Amazon Q Developer Pro proﬁle and subscribe yourself 1. Sign in to the AWS Management Console using your standalone AWS account. Sign in as the root user, or as an IAM user with the permissions described in Prerequisites. 2. Switch to the Amazon Q Developer console. 3. Make sure you're in the AWS Region where you want to install the Amazon Q Developer proﬁle and where you want to store user data. For supported Regions, see Supported Regions for the Q Developer console and Q Developer proﬁle. 4. Choose the Get started button. Note If you see a Settings button instead of Get started button, it means that you've already run through the 'Get started' workﬂow and can skip to Step 2: Subscribe team members. A Create your user dialog box appears. 5. Enter your information. The email address can be the same or diﬀerent from the one you used to sign up for your AWS account. Choose Continue. The Create Amazon Q Developer proﬁle dialog box appears. 6. Review the contents of the dialog box and provide a name for your proﬁle in Proﬁle name. For help with cross-region inferencing, see Cross-region processing in Amazon Q Developer. For help with disabling dashboard metrics, see Disabling the Amazon Q Developer dashboard. Choose Create application. Subscribing users 17 Amazon Q Developer User Guide The Amazon Q Developer proﬁle and managed application are installed, and your subscription is created. 7. (Optional) Verify that your subscription was created: 1. In the Amazon Q Developer console, in the navigation pane, choose Subscriptions. 2. In the main pane, choose the Users tab. Your subscription should appear in the list in the Pending state. If not, refresh your browser tab. Note Your subscription will change to the Active state after your ﬁrst use of Amazon Q Developer features. Now that you are subscribed, you must activate your subscription. You can do this now, or after you've subscribed team members, as described in the next section. To activate your subscription, check your inbox for emails titled Invitation to join AWS IAM Identity Center and Activate Your Amazon Q Developer Pro Subscription. Follow the instructions in these emails to activate your Amazon Q Developer Pro subscription and set up Amazon Q Developer Pro in your IDE. You should receive these emails within 24 hours. Step 2: Subscribe team members You might want to subscribe other team members so that they can try out Amazon Q Developer Pro with you. To subscribe them, use the following instructions. To add team members 1. Switch to the IAM Identity Center console (not the IAM console). Subscribing users 18 Amazon Q Developer Note User Guide IAM Identity Center was set up on your behalf when you subscribed yourself. For more information about the IAM Identity Center that was set up, see What resources were created?. 2. Add users and groups. For instructions, see Add users to your IAM Identity Center directory in the AWS IAM Identity Center User Guide. 3. Go to the next procedure to subscribe team members. Subscribing users 19 Amazon Q Developer To subscribe team members User Guide 1. Return to the Amazon Q Developer console. 2. In the navigation pane, choose Subscriptions, and then choose Subscribe. The Assign users and groups dialog box appears. 3. Start typing the name of a team member or group that you added. The name should auto- populate. 4. Choose Assign. 5. Have users check their email. They should receive an email titled Activate Your Amazon Q Developer Pro Subscription within 24 hours. In this email, users will ﬁnd guidance on how to begin using their Amazon Q Developer Pro license in the AWS Management Console and their Integrated Development Environment (IDE). The email includes users' unique Start URL and AWS Region for authentication, and provides quickstart steps for using Amazon Q Developer in their IDE. This email streamlines the onboarding process and saves you valuable time by eliminating the need for you to manually notify each new user. What resources were created? When you subscribed yourself (and optionally, team members), Amazon Q created the following AWS resources on your behalf: • An account instance of IAM Identity Center. For
amazonq-developer-ug-010	amazonq-developer-ug.pdf	10	on how to begin using their Amazon Q Developer Pro license in the AWS Management Console and their Integrated Development Environment (IDE). The email includes users' unique Start URL and AWS Region for authentication, and provides quickstart steps for using Amazon Q Developer in their IDE. This email streamlines the onboarding process and saves you valuable time by eliminating the need for you to manually notify each new user. What resources were created? When you subscribed yourself (and optionally, team members), Amazon Q created the following AWS resources on your behalf: • An account instance of IAM Identity Center. For more information about account instances of IAM Identity Center, see Account instances of IAM Identity Center in the AWS IAM Identity Center User Guide. Note Account instances of IAM Identity Center have limitations. For example, account instances don't support console access. (Users can still use Amazon Q in the console, it's just that they'll be subject to the Free tier monthly limits.) If you want to use Amazon Q Developer Pro in the console and other AWS websites, you must be a user in an organization instance of IAM Identity Center, in a management account. For more information, see Subscribe users to Amazon Q Developer Pro in a management account. Subscribing users 20 Amazon Q Developer Note User Guide You can't convert or merge an account instance of IAM Identity Center into an organization instance. • The ﬁrst user, in IAM Identity Center. You might have manually added team members too. • Pro tier subscriptions for the ﬁrst user and team members, in Amazon Q Developer. • An Amazon Q Developer proﬁle, in the Amazon Q Developer console, under Settings. • A managed application called QDefaultProﬁle, in the IAM Identity Center that is set up in your standalone account. The application is associated with the Amazon Q Developer proﬁle. Like the Amazon Q Developer proﬁle, the application is created once and shared between all Amazon Q subscribers in your standalone account. Subscribe users to Amazon Q Developer Pro in a management account A management account is an AWS account that is part of an organization managed by AWS Organizations. It is the ultimate owner of the organization, and is responsible for paying all charges accrued by the accounts in its organization. If you are the owner of a management account, use the following instructions to subscribe users to Amazon Q Developer Pro in your account. Not sure whether to subscribe users in a management or member account? See Subscribe users to Amazon Q Developer Pro across accounts for help. For more information about organizations and management accounts, see Terminology and concepts for AWS Organizations in the AWS Organizations User Guide. Prerequisites Before you begin, make sure that: • You have a management AWS account. • You have the minimum permissions required to subscribe users and manage Amazon Q Developer settings. For more information, see Allow administrators to use the Amazon Q console, and Allow administrators to use the Amazon Q Developer console. Subscribing users 21 Amazon Q Developer User Guide • You have an organization instance of IAM Identity Center set up in your management account. This IAM Identity Center contains the users you want to subscribe to Amazon Q Developer Pro, and must be deployed in a supported AWS Region, as described in Supported Regions for IAM Identity Center. For more information about IAM Identity Center, see Organization instances of IAM Identity Center. Step 1: Install the Amazon Q Developer proﬁle 1. 2. Sign in to the AWS Management Console using your AWS management account. Switch to the Amazon Q Developer console. 3. Make sure you're in the AWS Region where you want to install the Amazon Q Developer proﬁle and where you want to store user data. For supported Regions, see Supported Regions for the Q Developer console and Q Developer proﬁle. 4. Choose Get started. The Create Amazon Q Developer proﬁle dialog box appears. 5. Review the contents of the dialog box and provide a name for your proﬁle in Proﬁle name. For help with: • Cross-region inferencing, see Cross-region processing in Amazon Q Developer. • The Share Amazon Q Developer settings with member account check box, see Enabling proﬁle sharing in Amazon Q Developer and Deployment options for Amazon Q Developer Pro if you're using AWS Organizations. • Disabling dashboard metrics, see Disabling the Amazon Q Developer dashboard. Choose Create application. The Amazon Q Developer proﬁle and managed application are installed. Step 2: Subscribe users 1. In the Amazon Q Developer console, from the navigation pane, choose Subscriptions. 2. Choose Subscribe. The Assign users and groups dialog box appears. Subscribing users 22 Amazon Q Developer User Guide 3. Start typing the group or user you want to subscribe. The group or user will auto-populate with the
amazonq-developer-ug-011	amazonq-developer-ug.pdf	11	see Enabling proﬁle sharing in Amazon Q Developer and Deployment options for Amazon Q Developer Pro if you're using AWS Organizations. • Disabling dashboard metrics, see Disabling the Amazon Q Developer dashboard. Choose Create application. The Amazon Q Developer proﬁle and managed application are installed. Step 2: Subscribe users 1. In the Amazon Q Developer console, from the navigation pane, choose Subscriptions. 2. Choose Subscribe. The Assign users and groups dialog box appears. Subscribing users 22 Amazon Q Developer User Guide 3. Start typing the group or user you want to subscribe. The group or user will auto-populate with the ones available in the IAM Identity Center set up in your management account. 4. Choose Assign. 5. Have users check their email. They should receive an email titled Activate Your Amazon Q Developer Pro Subscription within 24 hours. In this email, users will ﬁnd guidance on how to begin using their Amazon Q Developer Pro license in the AWS Management Console and their Integrated Development Environment (IDE). The email includes users' unique Start URL and AWS Region for authentication, and provides quickstart steps for using Amazon Q Developer in their IDE. This email streamlines the onboarding process and saves you valuable time by eliminating the need for you to manually notify each new user. Step 3: Enable identity-enhanced console sessions If you want to allow users to use their Amazon Q Developer Pro subscription on AWS apps and websites, enable identity-enhanced console sessions. For more information, see Enabling identity- enhanced console sessions in the AWS IAM Identity Center User Guide. Note If you don't enable identity-enhanced console sessions, users can still use Amazon Q on AWS apps and websites, but they'll be limited to the Free tier. What resources were created? When you installed the Amazon Q Developer proﬁle and subscribed users in your management account, Amazon Q created the following resources on your behalf: • Pro tier subscriptions for users, in Amazon Q Developer. • An Amazon Q Developer proﬁle, in the Amazon Q Developer console, under Settings. • A managed application called QDefaultProﬁle, in the IAM Identity Center that is set up in your management account. The application is associated with the Amazon Q Developer proﬁle. Like the Amazon Q Developer proﬁle, the application is created once and shared between all Amazon Q subscribers in your management account. Subscribing users 23 Amazon Q Developer Note User Guide Amazon Q can create the QDefaultProﬁle managed application in a maximum of 50 AWS accounts within an organization. Subscribe users to Amazon Q Developer Pro in a member account A member account is an AWS account, other than the management account, that is part of an organization managed by AWS Organizations. If you are the owner of a member account, you have a few options for subscribing users to Amazon Q Developer Pro: • Option 1: You can create new users and groups in your member account, and then subscribe them. • Option 2: If you have existing users and groups in an IAM Identity Center instance in your member account, you can create subscriptions for these users in your member account. • Option 3: If you have existing users and groups in an IAM Identity Center instance in a management account, you can create subscriptions for these users in your member account. For all options, use the following instructions to subscribe users. Not sure whether to subscribe users in a member or management account? See Subscribe users to Amazon Q Developer Pro across accounts for help. For more information about organizations, member accounts, and management accounts, see Terminology and concepts for AWS Organizations in the AWS Organizations User Guide. Prerequisites Before you begin, make sure that: • You have a member AWS account. • You have the minimum permissions required to subscribe users and manage Amazon Q Developer settings. For more information, see Allow administrators to use the Amazon Q console, and Allow administrators to use the Amazon Q Developer console. Subscribing users 24 Amazon Q Developer User Guide • (Optional) You have an organization instance of IAM Identity Center set up in the management account or you have an account instance of IAM Identity Center set up in your member account. This IAM Identity Center contains the users you want to subscribe to Amazon Q Developer Pro, and must be deployed in a supported AWS Region, as described in Supported Regions for IAM Identity Center. If you don't have an IAM Identity Center instance installed, that's ok. One will be installed when you subscribe the ﬁrst user. For more information about IAM Identity Center, see Organization and account instances of IAM Identity Center. Step 1: Install the Amazon Q Developer Pro proﬁle and subscribe the ﬁrst user 1. 2. Sign in to the AWS Management Console using your member
amazonq-developer-ug-012	amazonq-developer-ug.pdf	12	member account. This IAM Identity Center contains the users you want to subscribe to Amazon Q Developer Pro, and must be deployed in a supported AWS Region, as described in Supported Regions for IAM Identity Center. If you don't have an IAM Identity Center instance installed, that's ok. One will be installed when you subscribe the ﬁrst user. For more information about IAM Identity Center, see Organization and account instances of IAM Identity Center. Step 1: Install the Amazon Q Developer Pro proﬁle and subscribe the ﬁrst user 1. 2. Sign in to the AWS Management Console using your member AWS account. Switch to the Amazon Q Developer console. 3. Make sure you're in the AWS Region where you want to install the Amazon Q Developer proﬁle and where you want to store user data. For supported Regions, see Supported Regions for the Q Developer console and Q Developer proﬁle. 4. Choose the Get started button. Note If you see a Settings button instead of Get started button, it means that you've already run through the 'Get started' workﬂow and can skip to Step 2: Subscribe other users. 5. Follow the on-screen prompts to subscribe your ﬁrst user. • If the ﬁrst user's email address matches one in an existing IAM Identity Center in either your member account or a management account, then Amazon Q connects to that IAM Identity Center. • If the ﬁrst user's email address doesn't match one in an existing IAM Identity Center, then Amazon Q creates an IAM Identity Center account instance in your member account, and adds the ﬁrst user to it. Note that: • Amazon Q only creates an IAM Identity Center account instance if there is no IAM Identity Center already in your member account. • Otherwise, if there is an IAM Identity Center account instance in your member account, but the user is not in it, then Amazon Q creates the user in the existing IAM Identity Center. Subscribing users 25 Amazon Q Developer User Guide The Create Amazon Q Developer proﬁle dialog box appears. 6. Review the contents of the dialog box and provide a name for your proﬁle in Proﬁle name. For help with cross-region inferencing, see Cross-region processing in Amazon Q Developer. For help with disabling dashboard metrics, see Disabling the Amazon Q Developer dashboard. Choose Create application. The Amazon Q Developer proﬁle and managed application are installed, and the ﬁrst user is subscribed. 7. (Optional) Verify that the ﬁrst user's subscription was created: 1. In the Amazon Q Developer console, in the navigation pane, choose Subscriptions. 2. In the main pane, choose the Users tab. The subscription of the ﬁrst user should appear in the list in the Pending state. If not, refresh your browser tab. Note The subscription will change to the Active state after the user's ﬁrst use of Amazon Q Developer features. 8. Have the ﬁrst user check their email. They should receive an email titled Activate Your Amazon Q Developer Pro Subscription within 24 hours. In this email, users will ﬁnd guidance on how to begin using their Amazon Q Developer Pro license in the AWS Management Console and their Integrated Development Environment (IDE). The email includes users' unique Start URL and AWS Region for authentication, and provides quickstart steps for using Amazon Q Developer in their IDE. This email streamlines the onboarding process and saves you valuable time by eliminating the need for you to manually notify each new user. Step 2: Subscribe other users To subscribe other users, add them to your IAM Identity Center instance if they're not already there, and then subscribe them to Amazon Q Developer Pro by choosing Subscribe in the Amazon Q Developer console. Subscribing users 26 Amazon Q Developer User Guide For instructions on adding users to IAM Identity Center, see Add users to your IAM Identity Center directory in the AWS IAM Identity Center User Guide. Step 3: Enable identity-enhanced console sessions If you want to allow users to use their Amazon Q Developer Pro subscription on AWS apps and websites, enable identity-enhanced console sessions. For more information, see Enabling identity- enhanced console sessions in the AWS IAM Identity Center User Guide. If you don't enable identity-enhanced console sessions, users can still use Amazon Q on AWS apps and websites, but they'll be limited to the Free tier. Note The ability to enable identity-enhanced console sessions—and therefore the ability to use Amazon Q Developer Pro subscriptions on AWS apps and websites—is only supported with organization instances of IAM Identity Center, not account instances. What resources were created? When you subscribed users in your member account, Amazon Q created the following AWS resources on your behalf: • An account instance of IAM Identity Center. This instance is only created if the ﬁrst user you subscribed
amazonq-developer-ug-013	amazonq-developer-ug.pdf	13	don't enable identity-enhanced console sessions, users can still use Amazon Q on AWS apps and websites, but they'll be limited to the Free tier. Note The ability to enable identity-enhanced console sessions—and therefore the ability to use Amazon Q Developer Pro subscriptions on AWS apps and websites—is only supported with organization instances of IAM Identity Center, not account instances. What resources were created? When you subscribed users in your member account, Amazon Q created the following AWS resources on your behalf: • An account instance of IAM Identity Center. This instance is only created if the ﬁrst user you subscribed wasn't found in an existing IAM Identity Center in the member account or management account. For more information about account instances of IAM Identity Center, see Account instances of IAM Identity Center in the AWS IAM Identity Center User Guide. Note Account instances of IAM Identity Center have limitations. For example, account instances don't support console access. (Users can still use Amazon Q in the console, it's just that they'll be subject to the Free tier monthly limits.) If you want your users to be able to use Amazon Q Developer Pro in the console and other AWS websites, they must exist in an organization instance of IAM Identity Center, in a management account. For more information, see Subscribe users to Amazon Q Developer Pro in a management account. Subscribing users 27 Amazon Q Developer Note User Guide You can't convert or merge an account instance of IAM Identity Center into an organization instance. • The ﬁrst user, in IAM Identity Center. (You might have added team members too.) • Pro tier subscriptions for the ﬁrst user and other users, in Amazon Q Developer. • An Amazon Q Developer proﬁle, in the Amazon Q Developer console, under Settings. • A managed application called QDefaultProﬁle, in IAM Identity Center. The application is associated with the Amazon Q Developer proﬁle. Like the Amazon Q Developer proﬁle, the application is created once and shared between all Amazon Q Developer Pro subscribers in your member account. Note You can install the QDefaultProﬁle managed application in a maximum of 50 AWS accounts within an organization. Subscribe users to Amazon Q Developer Pro across accounts Note This page is intended for enterprise administrators who are using AWS Organizations and who want to deploy Amazon Q Developer Pro to their user base. If you're an individual who wants to use Amazon Q Developer Pro for personal use, or if you're an enterprise administrator who does not want to use AWS Organizations, see instead Subscribe users in a standalone account for end-to-end instructions on subscribing to Amazon Q Developer Pro. When using AWS Organizations, you'll have a mix of management and member accounts. To subscribe users, you'll need to make three key decisions across these accounts: • Decision 1: Where to enable AWS IAM Identity Center – IAM Identity Center is the service that you use to manage user identities. You can enable IAM Identity Center in a management Subscribing users 28 Amazon Q Developer User Guide or member account. For more information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide. • Decision 2: Where to install the Amazon Q Developer proﬁle – The proﬁle is a collection of Pro tier settings. You can install the proﬁle in a management or member account. For more information about the proﬁle, see Amazon Q Developer proﬁles. • Decision 3: Where to subscribe users – After you add users to IAM Identity Center, you must subscribe them. You can subscribe users in a management or member account. For more information about subscriptions, see Managing Amazon Q Developer Pro subscriptions. Your speciﬁc combination of these three decisions constitutes your deployment option. Deployment options are described in the following table. Deployment options for Amazon Q Developer Pro if you're using AWS Organizations Deploymen t option Deploymen t option 1: Deploy in managemen t and member accounts Description Advantages Disadvantages With this deployment option: More features. Because IAM Identity Complexity. Requires coordination across • In the management account, you enable IAM Identity Center. • In the management account, you install the Amazon Q Developer proﬁle and then share it with member accounts. • In a member account, you subscribe users. Center is installed in a accounts by multiple management account, administrators. it is considered to be an organization instance. Organization instances support all features of IAM Identity Center. For a list of supported features, see When to use an organization instance in the AWS IAM Identity Center User Guide. Distributed managemen t. Subscription management tasks Subscribing users 29 Amazon Q Developer Deploymen t option Description Advantages Disadvantages User Guide are distributed across member accounts, which is a best practice. Deploymen t option 2: Deploy in
amazonq-developer-ug-014	amazonq-developer-ug.pdf	14	and then share it with member accounts. • In a member account, you subscribe users. Center is installed in a accounts by multiple management account, administrators. it is considered to be an organization instance. Organization instances support all features of IAM Identity Center. For a list of supported features, see When to use an organization instance in the AWS IAM Identity Center User Guide. Distributed managemen t. Subscription management tasks Subscribing users 29 Amazon Q Developer Deploymen t option Description Advantages Disadvantages User Guide are distributed across member accounts, which is a best practice. Deploymen t option 2: Deploy in a With this deployment option, you enable IAM More features. Because IAM Identity Center is Identity Center, install enabled in a managemen Centralized managemen t. Because users are subscribed in the managemen the Amazon Q Developer t account, it is considere management account, t account only proﬁle, and subscribe users in the managemen t account. d to be an organization and because of a instance. Organization limitation in Amazon instances support all Q Developer where features of IAM Identity delegated administr Center. For a list of ation is not supported supported features, , management account see When to use an administrators must organization instance handle subscription in the AWS IAM Identity management tasks. Center User Guide. You cannot follow the recommended practice of delegating tasks to member accounts. Subscribing users 30 Amazon Q Developer Deploymen t option Deploymen t option 3: Deploy in Description Advantages Disadvantages User Guide With this deployment option, you enable IAM Quick setup. Individua l member account Fewer features. Because IAM Identity Center is Identity Center, install administrators can enabled in a member a member the Amazon Q Developer deploy without waiting account, it is considere account only proﬁle, and subscribe users in a member account. or needing approval d to be an account for an enterprise-wide instance. Account implementation. instances support Flexibility for complex organizations. Use this option when you don't have a uniﬁed identity provider or identity store containing the entire user base that you want to subscribe to Amazon Q Developer Pro. fewer features than organization instances . For example, account instance don't support permission sets, which means that users cannot use their Amazon Q Developer Pro subscript ions in the AWS console and AWS websites. For a list of the limitations of account instances, see Account instance considerations in the AWS IAM Identity Center User Guide. Subscribe users to Amazon Q Developer Pro across AWS Regions When you subscribe a user to Amazon Q Developer Pro, you might need to work in two diﬀerent AWS Regions: • One Region for the IAM Identity Center instance (where user identities are managed, and where subscriptions are stored) • Another Region for the Amazon Q Developer console (where the Amazon Q Developer proﬁle, customizations, and subscriptions are managed) Subscribing users 31 Amazon Q Developer User Guide The Regions are not always the same because the Amazon Q Developer console is supported in fewer Regions than IAM Identity Center. For a list of Regions supported by IAM Identity Center and Amazon Q Developer console, see Amazon Q Developer Pro Region support. In a scenario where your IAM Identity Center is in a diﬀerent Region from your Amazon Q Developer console, use the guidance in the following example to subscribe users. Example subscription process in a multi-Region scenario Let's walk through subscribing a user where: • The name of the user is Shirley Rodriguez. • The IAM Identity Center instance is in US West (N. California). • The Amazon Q Developer console is in US East (N. Virginia). This is the closest Region to the IAM Identity Center instance that the Amazon Q Developer console supports. To subscribe Shirley Rodriguez 1. Add a user entry for Shirley in your IAM Identity Center instance in US West (N. California). 2. 3. Switch to the Amazon Q Developer console in the US East (N. Virginia). Subscribe Shirley through the Amazon Q Developer console in US East (N. Virginia). Upon being subscribed: • Shirley's subscription is created in US West (N. California). • Shirley's subscription is associated with her user entry in US West (N. California). • Shirley's subscription is associated with the Amazon Q Developer proﬁle in US East (N. Virginia). Additionally, any data that Amazon Q Developer needs to store on Shirley's behalf will be stored in US East (N. Virginia). For more information about data storage and security, see Encryption at rest. For detailed instructions on subscribing users, see Subscribing users to Amazon Q Developer Pro. Managing Amazon Q Developer Pro subscriptions This section helps you understand and manage Amazon Q Developer subscriptions, including conﬁguring Amazon Q Developer features, unsubscribing users, and troubleshooting common subscription issues to ensure your users have access to Amazon Q Developer features.
amazonq-developer-ug-015	amazonq-developer-ug.pdf	15	associated with the Amazon Q Developer proﬁle in US East (N. Virginia). Additionally, any data that Amazon Q Developer needs to store on Shirley's behalf will be stored in US East (N. Virginia). For more information about data storage and security, see Encryption at rest. For detailed instructions on subscribing users, see Subscribing users to Amazon Q Developer Pro. Managing Amazon Q Developer Pro subscriptions This section helps you understand and manage Amazon Q Developer subscriptions, including conﬁguring Amazon Q Developer features, unsubscribing users, and troubleshooting common subscription issues to ensure your users have access to Amazon Q Developer features. Managing subscriptions 32 User Guide Amazon Q Developer Topics • Amazon Q Developer Pro Region support • Amazon Q Developer Pro subscription billing • Amazon Q Developer subscription statuses • Managing account details in Amazon Q Developer • Managing the encryption method in Amazon Q Developer • Amazon Q Developer proﬁles • Enabling proﬁle sharing in Amazon Q Developer • Troubleshooting Amazon Q Developer Pro subscriptions • Viewing an aggregated list of Amazon Q Developer subscriptions • Unsubscribing users from Amazon Q Developer Pro Amazon Q Developer Pro Region support The AWS services and resources that support Amazon Q Developer Pro subscriptions are available in the following AWS Regions. For information about subscribing users across AWS Regions, see Subscribe users to Amazon Q Developer Pro across AWS Regions. Supported Regions for IAM Identity Center The users that you want to subscribe to Amazon Q Developer Pro must have user entries in an IAM Identity Center instance (or a connected identity provider) in one of the Regions listed on the Supported Regions page, except for opt-in Regions. If your users have user entries in an IAM Identity Center instance in an opt-in Region, they can't be subscribed, which means they will only have access to the Free tier in the AWS console, and they won’t have access to Amazon Q in the IDE. Regardless of your Amazon Q Developer users' Region, data is stored in the Region where you install the Amazon Q Developer proﬁle. For more information about Amazon Q Developer proﬁles, see Amazon Q Developer proﬁles. For more information about data protection, see Data protection in Amazon Q Developer. Supported Regions for the Q Developer console and Q Developer proﬁle The Amazon Q Developer console and Amazon Q Developer proﬁles are supported in the following Regions: Managing subscriptions 33 Amazon Q Developer • US East (N. Virginia) • Europe (Frankfurt) User Guide For more information about Amazon Q Developer proﬁles, see Amazon Q Developer proﬁles. Note The following features aren’t supported for Q Developer proﬁles created in the Europe (Frankfurt) Region: • Chatting with Support • Troubleshooting resources with Amazon Q • .NET transformations in the IDE • Amazon Q on the command line • Amazon Q in Eclipse • Amazon Q in chat applications (for Slack) • Amazon Q in the AWS Console Mobile Application Amazon Q Developer Pro subscription billing You will be billed monthly for each user that you subscribe to Amazon Q Developer Pro. For more information, see Amazon Q Developer pricing. If your business has AWS Organizations set up, billing for Amazon Q Developer Pro usage is per AWS organization. The management account gets the bill. If the same user is subscribed to Amazon Q Developer in multiple accounts within the same organization, you will not be double-billed. If you don't have AWS Organizations set up, the AWS account under which your users are subscribed gets the bill. You can view your bill in the Billing and Cost Management console. The Amazon Q expenses are listed on the Charges by service tab, under Q. For more information about the Billing and Cost Management console, see What is AWS Billing and Cost Management? in the AWS Billing User Guide. You can identify the cost of Amazon Q subscriptions for speciﬁc users with resource IDs through AWS Billing and Cost Management. To do so, in the Billing and Cost Management console under Managing subscriptions 34 Amazon Q Developer User Guide Data Exports, create either a standard data export or a legacy CUR export with the Include resource IDs option selected. To learn more, refer to Creating data exports in the AWS Data Exports User Guide. If you unsubscribe users, billing stops at the end of the billing cycle. For more information, see Unsubscribing users from Amazon Q Developer Pro. Amazon Q Developer subscription statuses You can view the status of your users' Amazon Q Developer Pro subscriptions on the Subscriptions page of the Amazon Q Developer console. The statuses will be slightly diﬀerent depending on whether you’re looking at the Groups tab or the Users tab. The statuses on the Groups tab are: • Subscribed – The group is subscribed to Amazon Q Developer Pro. You
amazonq-developer-ug-016	amazonq-developer-ug.pdf	16	data exports in the AWS Data Exports User Guide. If you unsubscribe users, billing stops at the end of the billing cycle. For more information, see Unsubscribing users from Amazon Q Developer Pro. Amazon Q Developer subscription statuses You can view the status of your users' Amazon Q Developer Pro subscriptions on the Subscriptions page of the Amazon Q Developer console. The statuses will be slightly diﬀerent depending on whether you’re looking at the Groups tab or the Users tab. The statuses on the Groups tab are: • Subscribed – The group is subscribed to Amazon Q Developer Pro. You will be charged for active user subscriptions in the group. • Unavailable – The group is subscribed, but its status is unavailable for one of the following reasons: • You are currently signed in to a management account, and the group was subscribed under a member account. To see the status of groups subscribed under member accounts, you must enable organization-wide visibility of subscriptions. For more information, see Viewing an aggregated list of Amazon Q Developer subscriptions. • You are currently signed in to a member account, and the group's identity is in an IAM Identity Center instance in the management account. There is no way to see the status of the group in this scenario. • Canceled – The group was canceled (unsubscribed) by an administrator. Users in the group can no longer access Amazon Q Developer Pro features. For more information, see Unsubscribing users from Amazon Q Developer Pro. The statuses on the Users tab are: • Active – The user has activated their subscription by using Amazon Q Developer features. You are being charged for this subscription. • Pending – The user is subscribed but has not activated their subscription. You are not being charged for this subscription. Managing subscriptions 35 Amazon Q Developer User Guide • Unavailable – The user is subscribed, but their status is unavailable for one of the following reasons: • You are currently signed in to a management account, and the user was subscribed under a member account. To see the status of users subscribed under member accounts, you must enable organization-wide visibility of subscriptions. For more information, see Viewing an aggregated list of Amazon Q Developer subscriptions. • You are currently signed in to a member account, and the user's identity is in an IAM Identity Center instance in the management account. There is no way to see the status of the user in this scenario. • Canceled – The user's subscription was canceled (unsubscribed) by an administrator, and the user can no longer access Amazon Q Developer features. For more information, see Unsubscribing users from Amazon Q Developer Pro. Managing account details in Amazon Q Developer To manage what features of Amazon Q Developer are available to your users and access the Start URL that your users need to access Amazon Q Developer in the IDE, use the following procedure. 1. Open the Amazon Q Developer console. To use the Amazon Q Developer console, you must have the permissions deﬁned in Allow administrators to use the Amazon Q Developer console. 2. Choose Settings. To update what features are available to your users, choose Edit in the Amazon Q Developer account details panel. Managing subscriptions 36 Amazon Q Developer User Guide 3. To copy the Start URL, choose the clipboard icon under Start URL. Provide the Start URL to your developers when they need to authenticate with their Amazon Q Developer Pro subscription in the IDE. For more information, see Using Amazon Q Developer in the IDE. Managing the encryption method in Amazon Q Developer By default, Amazon Q Developer uses an AWS managed key for encryption. For some features, you can set up a customer managed key to encrypt data. For a list of features that support encryption with customer managed keys, see Data encryption. Managing subscriptions 37 Amazon Q Developer User Guide To set the key used for encryption, complete the following procedure. 1. Open the Amazon Q Developer console. To use the Amazon Q Developer console, you must have the permissions deﬁned in Allow administrators to use the Amazon Q Developer console. 2. Choose Settings. 3. Choose Edit in the Amazon Q Developer account details panel. 4. On the Edit details page, expand the Encryption key - optional section. 5. To use a customer managed key for encryption, select Customize encryption settings (advanced). Managing subscriptions 38 Amazon Q Developer User Guide 6. In the search bar that appears, search for the name of the key you want to use for encryption or enter the key ARN. If you haven't created a key yet, choose Create an AWS KMS key, and then return to this page to add your key. 7. To disable encryption with your customer managed key
amazonq-developer-ug-017	amazonq-developer-ug.pdf	17	in the Amazon Q Developer account details panel. 4. On the Edit details page, expand the Encryption key - optional section. 5. To use a customer managed key for encryption, select Customize encryption settings (advanced). Managing subscriptions 38 Amazon Q Developer User Guide 6. In the search bar that appears, search for the name of the key you want to use for encryption or enter the key ARN. If you haven't created a key yet, choose Create an AWS KMS key, and then return to this page to add your key. 7. To disable encryption with your customer managed key and revert to an AWS managed key for encryption, deselect Customize encryption settings (advanced). Amazon Q Developer proﬁles An Amazon Q Developer proﬁle, also known as a settings proﬁle, is a collection of Amazon Q Developer settings associated with a set of Amazon Q Developer Pro subscribers and an Amazon Q Developer managed application. The very ﬁrst time you subscribe users in your account, you will be prompted to install this proﬁle. Installing the proﬁle causes settings to appear in the Amazon Q Developer console and makes Amazon Q Developer Pro features available for use. All subscriptions that you add to your account (during the initial subscription process, and later) will be associated with this proﬁle. You can also choose to install the proﬁle without subscribing users, for the reason outlined in Enabling proﬁle sharing in Amazon Q Developer. Other characteristics of the Amazon Q Developer proﬁle are: • The proﬁle is mandatory; without it, you won't be able to subscribe users. • The proﬁle can be installed once per supported AWS Region, per AWS account. For a list of AWS Regions supported by the Amazon Q Developer proﬁle, see Supported Regions for the Q Developer console and Q Developer proﬁle. Enabling proﬁle sharing in Amazon Q Developer If you are a management account administrator within an organization managed by AWS Organizations, you can enable the proﬁle sharing feature. When proﬁle sharing is enabled, the Amazon Q Developer proﬁle that has been installed in a management account will be shared with member accounts. There are two reasons you might want to this: • Administrative beneﬁts: Sharing the proﬁle means that all your member accounts will use the same Amazon Q Developer proﬁle and corresponding settings. The Amazon Q Developer Managing subscriptions 39 Amazon Q Developer User Guide proﬁle in the management account will override any Amazon Q Developer proﬁles that might be conﬁgured in member accounts, ensuring consistency across accounts. Use proﬁle sharing with Deployment option 1 described in Deployment options for Amazon Q Developer Pro if you're using AWS Organizations. • End user beneﬁts: Sharing the proﬁle allows users who are subscribed to Amazon Q Developer Pro in a management account to use their Amazon Q Developer Pro subscription to chat with Amazon Q in the AWS Management Console and other AWS websites while signed in to a member account. When proﬁle sharing is disabled, these users can still chat with Amazon Q in the member account, but they'll be subject to Free tier limits and features. Use the following instructions to enable proﬁle sharing. Prerequisites Before you begin, make sure that: • You are an administrator of an AWS management account. • You have an organization instance of IAM Identity Center set up in your management account and connected to Amazon Q. To check, sign in to your management account, go to the Amazon Q console, choose Settings, and make sure the following message appears at the top: Amazon Q connected to an organization instance of IAM Identity Center. • Your organization instance of IAM Identity Center contains users who are subscribed to Amazon Q Developer Pro in member accounts. • You have the minimum permissions required to access the Amazon Q Developer console. For more information, see Allow administrators to use the Amazon Q Developer console. To enable proﬁle sharing 1. 2. Sign in to the AWS Management Console using your AWS management account. Switch to the Amazon Q Developer console. 3. Choose Settings. 4. 5. Scroll to the Member account settings section and choose Edit. Enable Q Developer managed application and settings proﬁle. 6. Choose Save. Managing subscriptions 40 Amazon Q Developer User Guide Troubleshooting Amazon Q Developer Pro subscriptions If you are having trouble accessing Amazon Q Developer with a Amazon Q Developer Pro subscription, review the following scenarios to understand possible issues and how to resolve them. • You were recently added to a group, and your subscription is not yet active. If your administrator manages Amazon Q subscription access using identity provider groups, there might be a delay when they add users to the group. You might need to wait up to 24 hours for access to be activated. • You don't have
amazonq-developer-ug-018	amazonq-developer-ug.pdf	18	Managing subscriptions 40 Amazon Q Developer User Guide Troubleshooting Amazon Q Developer Pro subscriptions If you are having trouble accessing Amazon Q Developer with a Amazon Q Developer Pro subscription, review the following scenarios to understand possible issues and how to resolve them. • You were recently added to a group, and your subscription is not yet active. If your administrator manages Amazon Q subscription access using identity provider groups, there might be a delay when they add users to the group. You might need to wait up to 24 hours for access to be activated. • You don't have an active subscription. Try refreshing the page to use the Amazon Q Developer Free tier. • Your access to the Amazon Q Developer Pro managed application was revoked. You still have an active subscription, but your access to the Amazon Q Developer Pro managed application was revoked or the managed application was deleted. Contact your administrator to restore your access. • You don't have suﬃcient IAM permissions. You or your AWS administrator must update your IAM permissions to allow the use of Amazon Q Developer. For more information, see Identity-based policy examples for Amazon Q Developer. After you obtain the necessary permissions, reload the console page to access Amazon Q. • You don't have identity-enhanced console sessions set up. When attempting to use Amazon Q on AWS apps and websites, you see the following message in your browser: Your account has not been configured to use an Amazon Q subscription. You currently have access to the free tier of Amazon Q. Contact your AWS administrator to configure your subscription. When this message appears, it might be because you or your AWS administrator did not enable identity-enhanced console sessions. For information on how to enable identity-enhanced console sessions console sessions, see Enabling identity-enhanced console sessions. Managing subscriptions 41 Amazon Q Developer User Guide Viewing an aggregated list of Amazon Q Developer subscriptions If you are a management account administrator within an organization managed by AWS Organizations, you can conﬁgure Amazon Q to display Amazon Q Developer Pro subscriptions from both management and member accounts in a single, uniﬁed list on the Subscriptions page of the Amazon Q Developer console while signed in to your management account. This organization-wide visibility eliminates the need to sign in to multiple accounts to track your subscriptions. When oganization-wide visibility is enabled, users and groups subscribed in member accounts appear will appear as read-only with a greyed-out selector next to them, indicating that you cannot take action on them as a management account administrator. If you need to modify these users and groups, you must sign in to the member account that manages them. Note Uniﬁed subscription information will also appear on the Dashboard page of the Amazon Q Developer console when you enable organization-wide visibility. If you are a member account administrator, you will only ever be able to view the subscriptions within the member accounts that you administer. This is true regardless of whether organization- wide visibility was enabled in the management account. To enable organization-wide visibility of Amazon Q Developer subscriptions, you must enable trusted access to Amazon Q in your organization. Trusted access is an AWS Organizations feature that lets you designate Amazon Q as a trusted service that is allowed to query your organization's structure. This querying is required in order to show subscriptions in member accounts within the management account. To learn more about trusted access, see Enabling trusted access for AWS Account Management in the AWS Organizations User Guide. To learn more about member and management accounts, see Terminology and concepts for AWS Organizations in the AWS Organizations User Guide for explanations. Use the following instructions to enable trusted access to Amazon Q in your organization. Prerequisites Before you begin, make sure that: Managing subscriptions 42 Amazon Q Developer User Guide • You are an administrator of an AWS management account. • You have an organization instance of IAM Identity Center set up in your management account and connected to Amazon Q. To check, sign in to your management account, go to the Amazon Q console, choose Settings, and make sure the following message appears at the top: Amazon Q connected to an organization instance of IAM Identity Center. • Your organization instance of IAM Identity Center contains users who are subscribed to Amazon Q Developer Pro in member accounts. • You have the minimum permissions required to perform actions in the Amazon Q console. For more information, see Allow administrators to use the Amazon Q console. To enable trusted access (enable organization-wide visibility of subscriptions) 1. 2. Sign in to the AWS Management Console using your AWS management account. Switch to the Amazon Q Developer console. 3. Choose Settings. 4. 5. In Subscription view settings, choose Edit. Enable
amazonq-developer-ug-019	amazonq-developer-ug.pdf	19	Q connected to an organization instance of IAM Identity Center. • Your organization instance of IAM Identity Center contains users who are subscribed to Amazon Q Developer Pro in member accounts. • You have the minimum permissions required to perform actions in the Amazon Q console. For more information, see Allow administrators to use the Amazon Q console. To enable trusted access (enable organization-wide visibility of subscriptions) 1. 2. Sign in to the AWS Management Console using your AWS management account. Switch to the Amazon Q Developer console. 3. Choose Settings. 4. 5. In Subscription view settings, choose Edit. Enable the toggle. 6. Choose Save. Trusted access to Amazon Q is now enabled. Users and groups who are subscribed in member accounts now appear in the Amazon Q Developer console when you're signed in as a management account administrator. Unsubscribing users from Amazon Q Developer Pro If you are the administrator of an AWS standalone account, an AWS management account, or an AWS member account, use the following procedure to unsubscribe users from your account. For more information about AWS management and member accounts, see Managing AWS accounts in an organization with AWS Organizations. Notes about unsubscribing users: • If you are an administrator of either a management or member account within an organization managed by AWS Organizations, you can only unsubscribe users if your created their subscriptions. Managing subscriptions 43 Amazon Q Developer User Guide • If a user has been subscribed in both member and management accounts, both account administrators must unsubscribe the user from their respective accounts for the user to be fully unsubscribed. • If you are a management account administrator, you can view other accounts the user is subscribed in by choosing View subscriptions from member accounts on the Settings page of the Amazon Q Developer console. This allows you to coordinate with member account administrators for unsubscription. Alternatively, if you have the appropriate permissions, you can sign in as a member account administrator and unsubscribe the user directly. For more information about viewing member account subscriptions as a management account administrator, see Viewing an aggregated list of Amazon Q Developer subscriptions. • After unsubscribing users or groups, their subscriptions are marked as Canceled, and they can no longer access Amazon Q Developer features. (They can still use the Free tier though, provided they have not exceeded their Free tier limits.) The ﬁnal monthly subscription fee is charged at the end of the current billing cycle for all users who had active subscriptions. You'll be charged for the full month; the fee won't be prorated. To unsubscribe a user or group you manage 1. Sign in to the AWS Management Console using your AWS standalone, management, or member account. 2. Switch to the Amazon Q Developer console. 3. Choose the Users or Groups tab. 4. Choose the user or group you want to unsubscribe. 5. Choose More actions. 6. Choose Unsubscribe. Amazon Q Developer Free tier Amazon Q Developer is available at the Free tier on AWS apps and websites, in the IDE, and on the command line. When you use the Free tier, access to Amazon Q Developer features is limited. If you want to get started quickly with some Amazon Q Developer features, you can create an AWS Builder ID to use Amazon Q Developer in the IDE or on the command line. Builder ID is the authentication that we recommend for exploring the Free tier of Amazon Q Developer. To get started with a Builder ID, see Install the Amazon Q Developer extension or plugin in your IDE. Free tier 44 Amazon Q Developer User Guide To use Amazon Q Developer at the Free tier on AWS websites, sign in to your AWS account to try chat and other features in the AWS Management Console. Not all Amazon Q console features are available at the Free tier. At the Free tier, your content may be used to improve Amazon Q Developer. For more information, see Amazon Q Developer service improvement. Upgrading to the Pro tier There is no direct upgrade path from the Free tier to the Pro tier. Users cannot continue to use their Builder ID with the Pro tier and must subscribe as new users to Amazon Q Developer Pro by following the instructions in Subscribing users to Amazon Q Developer Pro. After subscribing, users must sign out and back in to Amazon Q to have their new Amazon Q Developer Pro subscription take eﬀect. Otherwise, they'll continue to operate using their Builder ID. Free tier features The following table describes which Amazon Q Developer features are available to you at the Free tier, depending on your sign in or authentication method: Amazon Q Developer feature Amazon Q on AWS websites Amazon Q Developer in the IDE Signed in to
amazonq-developer-ug-020	amazonq-developer-ug.pdf	20	must subscribe as new users to Amazon Q Developer Pro by following the instructions in Subscribing users to Amazon Q Developer Pro. After subscribing, users must sign out and back in to Amazon Q to have their new Amazon Q Developer Pro subscription take eﬀect. Otherwise, they'll continue to operate using their Builder ID. Free tier features The following table describes which Amazon Q Developer features are available to you at the Free tier, depending on your sign in or authentication method: Amazon Q Developer feature Amazon Q on AWS websites Amazon Q Developer in the IDE Signed in to Free tier as... A Builder ID user An IAM Identity Center user An IAM user No Yes Yes Yes No No Upgrading to the Pro tier 45 Amazon Q Developer User Guide Signed in to Free tier as... A Builder ID user An IAM Identity Center user An IAM user Amazon Q Developer feature Amazon Q Developer on the command line Yes No No For details about the features available at the Free tier, see the Amazon Q Developer pricing page. Free tier features 46 Amazon Q Developer User Guide Using Amazon Q Developer on AWS apps and websites Use Amazon Q Developer in the AWS Management Console, AWS Console Mobile Application, AWS Marketing website, AWS Documentation website, and supported chat applications to ask questions about AWS. You can ask Amazon Q about AWS architecture, best practices, support, and documentation. Amazon Q can also help with code that you're writing with the AWS SDKs and AWS Command Line Interface (AWS CLI). In the AWS Management Console, you can ask Amazon Q about your AWS resources and costs, contact Support directly, and diagnose common console errors. To quickly provide access to features of Amazon Q Developer on AWS, attach the AmazonQDeveloperAccess AWS managed policy to the IAM identity using Amazon Q. For permissions needed for speciﬁc features, see the topic for the feature you want to use. Topics • Authenticating to your Amazon Q Developer Pro subscription • Chatting with Amazon Q Developer about AWS • Using Amazon Q Developer plugins • Automating AWS services with Amazon Q Developer Console-to-Code • Diagnosing common errors in the console with Amazon Q Developer • Using Amazon Q Developer to chat with Support Authenticating to your Amazon Q Developer Pro subscription To access Amazon Q at the Free tier, sign in to the AWS Management Console. Any Free tier features are available as long as you have the required permissions. To access Amazon Q at the Pro tier, sign to the console with IAM Identity Center. When you sign in with IAM Identity Center, including authenticating through an external identity provider that is connected to IAM Identity Center, you will automatically have access to the Pro tier if your IAM Identity Center identity is subscribed to Amazon Q Developer Pro. For more information on the Amazon Q Developer Pro tier, see Understanding tiers of service for Amazon Q Developer. Authenticating to your Amazon Q Developer Pro subscription 47 Amazon Q Developer Note User Guide If you see an error message that starts with, Your account has not been configured to use an Amazon Q subscription, see Troubleshooting Amazon Q Developer Pro subscriptions for troubleshooting tips. If you sign in to the AWS console with IAM or federation with IAM, then you will be prompted to authenticate with IAM Identity Center when you reach a Free tier limit or attempt to use a feature only available at the Pro tier. Chatting with Amazon Q Developer about AWS Chat with Amazon Q in the AWS Management Console, AWS Console Mobile Application, AWS website, AWS Documentation website, and chat applications to learn about AWS services. You can ask Amazon Q about best practices, recommendations, step-by-step instructions for AWS tasks, and architecting your AWS resources and workﬂows. You can also ask Amazon Q about your AWS resources and account costs. Amazon Q additionally generates short scripts or code snippets to help you get started using the AWS SDKs and AWS CLI. Topics • Add permissions • Working with Amazon Q on AWS websites • Example questions • Chatting about your resources with Amazon Q Developer • Asking Amazon Q to troubleshoot your resources • Chatting about your costs • Chatting about your telemetry and operations Add permissions For an IAM policy that grants permissions needed for chatting with Amazon Q, see Allow users to chat with Amazon Q. Chatting about AWS 48 Amazon Q Developer User Guide Working with Amazon Q on AWS websites To chat with Amazon Q Developer in the AWS Management Console, choose the Amazon Q icon in the right sidebar. To chat on the AWS website or any AWS service’s documentation page, choose the Amazon Q icon in the bottom right corner. To ask
amazonq-developer-ug-021	amazonq-developer-ug.pdf	21	Q to troubleshoot your resources • Chatting about your costs • Chatting about your telemetry and operations Add permissions For an IAM policy that grants permissions needed for chatting with Amazon Q, see Allow users to chat with Amazon Q. Chatting about AWS 48 Amazon Q Developer User Guide Working with Amazon Q on AWS websites To chat with Amazon Q Developer in the AWS Management Console, choose the Amazon Q icon in the right sidebar. To chat on the AWS website or any AWS service’s documentation page, choose the Amazon Q icon in the bottom right corner. To ask Amazon Q a question, enter your question into the text bar in the Amazon Q panel. Amazon Q generates a response to your question with a sources section that links to its references. After you receive a response, you can optionally leave feedback by using the thumbs-up and thumbs-down icons. You can also copy the response to your clipboard by choosing the copy icon. Conversation history Amazon Q maintains your conversation within a given session as context to inform future responses. You can ask follow-up questions or refer to previous questions and responses throughout the duration of your session. If you’re using Amazon Q in the console, your current conversation and associated context are maintained when you navigate to another place in the console or to another browser or tab. If you’re using Amazon Q on the AWS website, Documentation website, or Console Mobile Application, a new conversation starts without any context when you navigate to a new page, browser, or tab. If you want to restart your conversation and clear the context provided by previous questions and responses, choose New conversation. Your previous conversation will no longer be used to inform responses from Amazon Q. Chat settings To update your chat settings in Amazon Q, choose the gear icon in the top right corner of the chat panel. You can specify the following settings: • Region — Amazon Q defaults to the AWS Region set in the AWS Management Console when you open the chat panel. To update the Region used by Amazon Q, change your console Region. Working with Amazon Q on AWS websites 49 Amazon Q Developer Example questions User Guide You can ask Amazon Q questions about AWS and AWS services, such as ﬁnding the right service or understanding best practices. You can also ask about software development with the AWS SDKs and AWS CLI. Amazon Q in the console can generate short scripts or code snippets to help you get started using the AWS SDKs and AWS CLI. The following are example questions that demonstrate how Amazon Q can help you build on AWS: • What’s the maximum runtime for a Lambda function? • When should I put my resources in a VPC? • What’s the best container service to use to run my workload if I need to keep my costs low? • How do I list my Amazon S3 buckets? • How do I create and host a website on AWS? Chatting about your resources with Amazon Q Developer Amazon Q Developer answers questions about your AWS account resources to help you understand your AWS infrastructure through natural language prompts. Using advanced reasoning capabilities, Amazon Q analyzes and provides insights about your resources so you can quickly get the information you need without relying on multiple service consoles, APIs, or complicated scripts. The type of resource analysis Amazon Q can perform includes: • Resource listing and details – Ask for lists or speciﬁc details about resources in your account. • Filtered queries – Request resource information based on criteria such as region or conﬁguration state. • Cross-service analysis – Ask complex questions about your infrastructure, conﬁgurations, and dependencies across multiple AWS resources and services. • Troubleshooting assistance – Get help identifying and resolving issues with your resources. For more information, see Asking Amazon Q to troubleshoot your resources. For examples of questions you can ask, see Ask Amazon Q for resource information. Example questions 50 Amazon Q Developer Topics • How it works • Prerequisites • Ask Amazon Q for resource information • Count resources with AWS Resource Explorer How it works User Guide To respond to questions about resources, Amazon Q uses service APIs and AWS Cloud Control API to retrieve the requested information. To allow Amazon Q to call the APIs required to retrieve requested resource information, your IAM identity must have permissions to use those APIs. For more information, see Prerequisites. Amazon Q can perform get, list, and describe actions to retrieve information about multiple AWS resources at a time. When asked complex resource questions, Amazon Q creates dynamic, multi- step plans that explain the reasoning behind the actions it’s taking to further your understanding of your AWS environment. If
amazonq-developer-ug-022	amazonq-developer-ug.pdf	22	Guide To respond to questions about resources, Amazon Q uses service APIs and AWS Cloud Control API to retrieve the requested information. To allow Amazon Q to call the APIs required to retrieve requested resource information, your IAM identity must have permissions to use those APIs. For more information, see Prerequisites. Amazon Q can perform get, list, and describe actions to retrieve information about multiple AWS resources at a time. When asked complex resource questions, Amazon Q creates dynamic, multi- step plans that explain the reasoning behind the actions it’s taking to further your understanding of your AWS environment. If the initial plan fails, Amazon Q attempts alternative methods or prompts you for any additional information required to continue. Amazon Q can’t answer questions about the data stored in your resources, such as listing objects in an Amazon S3 bucket, or questions related to your account security, identity, credentials, or cryptography. Prerequisites You can chat about your account resources with Amazon Q in the AWS Management Console, AWS Console Mobile Application, and in conﬁgured chat applications. To chat about your resources, your IAM identity must have the following permissions: • Permissions to chat with Amazon Q, to use Cloud Control API, and to allow Amazon Q to access your resources. For an IAM policy that grants the required permissions, see Allow users to chat about resources with Amazon Q. • Permissions to access the resources you ask about. For example, if you ask Amazon Q to list your Amazon S3 buckets, you must have the s3:ListAllMyBuckets permission. Amazon Q will never access resources that your IAM identity doesn't have access to. Chatting about your resources 51 Amazon Q Developer Important User Guide Normal fees apply when you ask Amazon Q to perform read, list, or describe actions. For more information, see the pricing page for the AWS service you are asking Amazon Q about. Ask Amazon Q for resource information When you ask Amazon Q about your resources, you can specify the AWS Region that Amazon Q calls to locate your resources. If no Region is speciﬁed in a given query, Amazon Q will use a Region previously speciﬁed in your conversation if applicable, and otherwise uses your current console Region (or the most recent console Region if you are using a global console Region). Amazon Q might need additional information to answer to your resource questions. When Amazon Q asks a follow up, reply with the requested details. Following are example questions you can ask Amazon Q about your resources: • Describe the encryption settings for S3 bucket <name> • What SQS queues invoke my Lambda functions? • Do I have any MySQL RDS clusters that need updates? • List my EC2 instances in <region> • Get the conﬁguration for my lambda function <name> • What alarms are conﬁgured for instance <instance ID>? Count resources with AWS Resource Explorer When you ask a question that requires resource counting, such as 'How many EC2 resources are running in my account?', Amazon Q uses Cloud Control API by default to return a count of the requested resources. You also have the option to enable and conﬁgure Resource Explorer for faster resource counting with Amazon Q. If Resource Explorer is enabled, Amazon Q will attempt to use it when generating a response that requires counting your resources. Amazon Q can use Resource Explorer to count a single type of resource across all AWS Regions. Using Resource Explorer enables Amazon Q to count resources Chatting about your resources 52 Amazon Q Developer User Guide faster by returning the count from the Resource Explorer index, as opposed to calling service APIs to list resources and count the results. If you choose to enable Resource Explorer for resource counting, note that resource information can be out of date. Resource Explorer indexes resources in your account by taking a periodic inventory, and if resources have been created or deleted after the last inventory, the resource count will be incorrect. Resource Explorer also doesn't support resource ﬁltering. If you ask to count resources matching a speciﬁc criteria, Amazon Q will fall back to Cloud Control API. If you don't have Resource Explorer enabled and conﬁgured for use, or if Amazon Q can't use Resource Explorer to answer your question, Amazon Q uses Cloud Control API to count resources. Using Cloud Control API ensures an accurate resource count and supports resource ﬁltering, however this can also lead to increased latency compared to counting with Resource Explorer. If you are counting a large number of resources, Cloud Control API can also time out. To use Resource Explorer for resource counting, the following conﬁguration is required: • The user interacting with Amazon Q must be in account where an Resource Explorer default view is conﬁgured and an aggregator index has
amazonq-developer-ug-023	amazonq-developer-ug.pdf	23	or if Amazon Q can't use Resource Explorer to answer your question, Amazon Q uses Cloud Control API to count resources. Using Cloud Control API ensures an accurate resource count and supports resource ﬁltering, however this can also lead to increased latency compared to counting with Resource Explorer. If you are counting a large number of resources, Cloud Control API can also time out. To use Resource Explorer for resource counting, the following conﬁguration is required: • The user interacting with Amazon Q must be in account where an Resource Explorer default view is conﬁgured and an aggregator index has been created in the same Region as the default view. For more information, see Setting up Resource Explorer using Advanced setup in the AWS Resource Explorer User Guide. • The user's IAM identity must have read permissions for the default view. For more information, see Granting access to Resource Explorer views for search in the AWS Resource Explorer User Guide. Asking Amazon Q to troubleshoot your resources In the AWS Management Console, you can ask Amazon Q to troubleshoot issues you're having with your AWS resources. When you encounter a problem, open the chat panel and describe the situation to Amazon Q. For instance, you might enter, "I can't add an object to my S3 bucket" or "My load balancer is returning a 503 error". Amazon Q analyzes the information you provided to identify potential root causes. It then oﬀers tailored solutions, step-by-step instructions, or best practices to resolve your issue eﬃciently. Amazon Q currently accepts English prompts for the issues shown in the following table. Asking Amazon Q to troubleshoot your resources 53 Amazon Q Developer AWS service Type of issue that Amazon Q can help with Example prompts User Guide Amazon S3 Permissions issues AWS Glue Job failures Amazon Athena Query issues Why can’t I put objects into my S3 bucket? The bucket ID is amzn-s3-demo-bucket. Why can’t I delete the object s3://amzn-s3-demo-bucket- locked/Q-Stream2.jpg? Why can't I delete an object in S3? My Glue job with the job name 'Run111B11B11-<…>' and the job run id 'bb_b1b11 1<…>' in the 'us-west-2' region failed. Why did my Glue job called GlueRun00AA00A00A-<…> fail? My Athena query didn't return any results. query ID: 222c22cc-2c022-<…> region id: us-east-2 I ran an Athena query with an execution ID of 333d33dd- 3d33-<…> and a region of us- east-1, and it didn't return any results. Amazon ECS Task stoppage issues; Fargate health check issues; disconnec My ECS task is stopped and I don't know why. The details ted agent issues of the task are: Cluster: my- Asking Amazon Q to troubleshoot your resources 54 Amazon Q Developer AWS service Type of issue that Amazon Q can help with Example prompts User Guide ecs-cluster, Service: my-ecs- service, Task Deﬁnition: my- task-deﬁnition, Task ARN: arn:aws:ecs:us-west-2:44444 4444444:task/my-ecs-cluster /4ee4ee4ee4444<…> I'm having a problem with my ECS task. The task health check always fails for the task in the 'my-ecs-cluster' cluster and service. The Amazon ECS agent on one of my container instances appears to be disconnected. The agent is not responding or updating its status, which is causing tasks to be stuck in a pending state. Amazon EC2 Elastic Load Balancing Health check issues; 504, 503, 502, and 500 errors Why are the health checks for the target group called 'my- target-group' failing? Why am I receiving 503 errors from my load balancer 'my- elb'? Asking Amazon Q to troubleshoot your resources 55 Amazon Q Developer AWS service Amazon EKS User Guide Type of issue that Amazon Q can help with Example prompts Application Load Balancer (ALB) ingress controller issues; I have an ALB ingress controller in my EKS cluster, managed add-on issues and am seeing a failure with the error message 'WebIdent ityErr:failed to retrieve credentials'. The AWS region is us-west-2. There seems to be an issue with the add-ons in my EKS cluster called my-eks-cluster, in the us-west-2 region. Amazon ECR Secondary account access issues I'm having diﬃculty granting access to an Amazon ECR image repository from a diﬀerent AWS account. Speciﬁcally, I need to allow account 222222222222 to push and pull images from the repository named "my- ecr-repo" in my account (111111111111) in the region (us-west-2). For Amazon Q to troubleshoot your resources, you'll need the same permissions as those outlined in Chatting about your resources with Amazon Q Developer. Chatting about your costs You can ask Amazon Q about your AWS bill and account costs. Amazon Q can retrieve your cost data, explain costs, and analyze cost trends, so you can understand your costs without referring to documentation or interrupting your workﬂow. Chatting about your costs 56 Amazon Q Developer User Guide When you ask Amazon Q about your costs, its response includes information about the requested cost ﬁgure, including the metric, time period and granularity,
amazonq-developer-ug-024	amazonq-developer-ug.pdf	24	Amazon Q to troubleshoot your resources, you'll need the same permissions as those outlined in Chatting about your resources with Amazon Q Developer. Chatting about your costs You can ask Amazon Q about your AWS bill and account costs. Amazon Q can retrieve your cost data, explain costs, and analyze cost trends, so you can understand your costs without referring to documentation or interrupting your workﬂow. Chatting about your costs 56 Amazon Q Developer User Guide When you ask Amazon Q about your costs, its response includes information about the requested cost ﬁgure, including the metric, time period and granularity, and any groups or ﬁlters applied to retrieve the cost data. It also provides a link to an AWS Cost Explorer view with the same speciﬁcations, so you can see visualizations or download the data for your own analysis. For more information about cost analysis in Amazon Q, see Analyzing your Cost Explorer data with Amazon Q in the AWS Cost Management User Guide. Prerequisites You can chat about your AWS costs in the AWS Management Console and in conﬁgured chat applications. For Amazon Q to answer questions about your costs, the following prerequisites must be met. Add permissions To chat about your costs, your IAM identity must have the following permissions: • Permissions to chat with Amazon Q and to allow Amazon Q to access your billing data. For an IAM policy that grants the required permissions, see Allow Amazon Q to perform actions on your behalf in chat. • ce:GetCostAndUsage, ce:GetCostForecast , ce:GetTags ,ce:GetCostCategories , ce:GetDimensionValues to get Cost Explorer billing data. Enable AWS Cost Explorer To chat about your costs with Amazon Q, you must enable AWS Cost Explorer in your AWS account. To enable Cost Explorer, open the Cost Explorer console. For more information, see Enabling Cost Explorer in the AWS Cost Management User Guide. Example questions Following are example questions about costs that you can ask Amazon Q: • How much did we spend on SageMaker AI in January? • What are the top contributing services to my AWS bill in the 'eu-central-1' region? • What were my Amazon EC2 costs by instance type last week? • What was my cost breakdown by service for the past three months? • Which linked accounts increased their spend the most from January to February? Chatting about your costs 57 Amazon Q Developer User Guide • Which linked accounts spent the most on DynamoDB last month? • What were my cost trends by region over the last three months? Chatting about your telemetry and operations Amazon Q analyzes your CloudWatch telemetry and operational data to help manage your AWS environment. It retrieves resource health information, monitors alarms, and provides troubleshooting guidance. When you ask questions, Amazon Q may prompt you for speciﬁc details like resource names and time ranges to ensure accurate assistance. AWS service health check: Evaluate the health of resources of speciﬁed AWS services, assisting customers in troubleshooting and resolving issues or errors they encounter with these resources. • Is my Lambda function X healthy? • Is anything wrong with my Amazon ECS clusters? • Help me troubleshoot my DynamoDB tables between time X and Y. • Investigate anomalies related to Amazon S3 between time X and Y. Alarm troubleshooting: Identiﬁes alarms in Alarm state and the underlying telemetry that triggered the alarm, helping customers diagnose the reasons behind the alarm/alert/pages. • Why is my alarm with name X ﬁring? Application Signals speciﬁc troubleshooting: Analyzes CloudWatch Application Signals service- level objectives and indicators to determine the overall health of a service, enabling you to assess and maintain application performance. • Is my Service X in environment Y healthy? For more information about Amazon Q operational investigations, see Amazon Q Developer operational investigations in the Amazon CloudWatch User Guide. Using Amazon Q Developer plugins Amazon Q Developer integrates with third party monitoring tools and security platforms so you can access your AWS application insights without leaving the AWS builder environment. In the Chatting about your telemetry and operations 58 Amazon Q Developer User Guide AWS Management Console, you can chat about metrics provided by these tools to understand and address application performance, errors, or vulnerabilities. After you conﬁgure a plugin, add the plugin alias to the beginning of your question when you chat with Amazon Q in the AWS console. Amazon Q calls the third party provider APIs to retrieve resources and generates a response with deep links to the external resources. When Amazon Q calls a third party API, the API will not appear in AWS CloudTrail logs. The CloudTrail log will only show when an AWS Secrets Manager secret is accessed by Amazon Q to retrieve credentials to connect to the third party provider. Amazon Q doesn't share any information with third party providers when
amazonq-developer-ug-025	amazonq-developer-ug.pdf	25	conﬁgure a plugin, add the plugin alias to the beginning of your question when you chat with Amazon Q in the AWS console. Amazon Q calls the third party provider APIs to retrieve resources and generates a response with deep links to the external resources. When Amazon Q calls a third party API, the API will not appear in AWS CloudTrail logs. The CloudTrail log will only show when an AWS Secrets Manager secret is accessed by Amazon Q to retrieve credentials to connect to the third party provider. Amazon Q doesn't share any information with third party providers when you conﬁgure or use plugins. For more information on how Amazon Q uses your data, see Data protection. Note Member accounts within an AWS organization don't have access to plugins that are conﬁgured in the organization's management account proﬁle. Each member account must create their own Q Developer proﬁle before they can conﬁgure and use plugins in their account. Warning Third party provider user permissions are not detected by Amazon Q Developer plugins. When an administrator conﬁgures a plugin in an AWS account, users with plugin permissions in that account have access to any resources in the third party provider account retrievable by the plugin. You can conﬁgure IAM policies to restrict which plugins users have access to. For more information, see Allow users to chat with plugins from one provider. To get started, see the topic for the plugin you want to use with Amazon Q Developer. Topics • Conﬁguring the Amazon Q Developer CloudZero plugin • Conﬁguring the Amazon Q Developer Datadog plugin • Conﬁguring the Amazon Q Developer Wiz plugin Using plugins 59 Amazon Q Developer User Guide Conﬁguring the Amazon Q Developer CloudZero plugin CloudZero is a cloud cost optimization platform that evaluates costs to improve cloud eﬃciency. If you use CloudZero to monitor your AWS costs, you can use the CloudZero plugin in Amazon Q Developer chat to access cost insights without leaving the AWS Management Console. You can use the CloudZero plugin to understand your AWS costs, get cost optimization insights, and track billing. After you receive a response, you can ask follow up questions, such as the status or cost impact of CloudZero insights. To conﬁgure the plugin, you provide authentication credentials from your CloudZero account to enable a connection between Amazon Q and CloudZero. After you conﬁgure the plugin, you can access CloudZero data by adding @cloudzero to the beginning of your question in Amazon Q chat. Warning CloudZero user permissions are not detected by the CloudZero plugin in Amazon Q. When an administrator conﬁgures the CloudZero plugin in an AWS account, users with plugin permissions in that account have access to any resources in the CloudZero account retrievable by the plugin. You can conﬁgure IAM policies to restrict which plugins users have access to. For more information, see Conﬁgure user permissions. Prerequisites Add permissions To conﬁgure plugins, the following administrator level permissions are required: • Permissions to access the Amazon Q Developer console. For an example IAM policy that grants needed permissions, see Allow administrators to use the Amazon Q Developer console. • Permissions to conﬁgure plugins. For an example IAM policy that grants the needed permissions, see Allow administrators to conﬁgure plugins. CloudZero 60 Amazon Q Developer Acquire credentials User Guide Before you begin, note the following information from your CloudZero account. These authentication credentials will be stored in an AWS Secrets Manager secret when you conﬁgure the plugin. • API key – An access key that allows Amazon Q to call the CloudZero API to access your organization’s cost insights and billing information. You can ﬁnd the API key in your CloudZero account settings. For more information, see the Authorization in the CloudZero documentation. For more information on acquiring credentials from your CloudZero account, see the CloudZero documentation. Secrets and service roles AWS Secrets Manager secret When you conﬁgure the plugin, Amazon Q creates a new AWS Secrets Manager secret for you to store CloudZero authentication credentials. Alternatively, you can use an existing secret that you create yourself. If you create a secret yourself, enter the API key as plaintext: your-api-key For more information about creating secrets, see Create a secret in the AWS Secrets Manager User Guide. Service roles To conﬁgure the CloudZero plugin in Amazon Q Developer, you need to create a service role that gives Amazon Q permission to access your Secrets Manager secret. Amazon Q assumes this role to access the secret where your CloudZero credentials are stored. When you conﬁgure the plugin in the AWS console, you have the option to create a new secret or use an existing one. If you create a new secret, the associated service role is created for you. If you use an existing secret and an existing service
amazonq-developer-ug-026	amazonq-developer-ug.pdf	26	a secret in the AWS Secrets Manager User Guide. Service roles To conﬁgure the CloudZero plugin in Amazon Q Developer, you need to create a service role that gives Amazon Q permission to access your Secrets Manager secret. Amazon Q assumes this role to access the secret where your CloudZero credentials are stored. When you conﬁgure the plugin in the AWS console, you have the option to create a new secret or use an existing one. If you create a new secret, the associated service role is created for you. If you use an existing secret and an existing service role, make sure your service role contains the following permissions, and has the following trust policy attached. The service role required depends on your secret encryption method. CloudZero 61 Amazon Q Developer User Guide If your secret is encrypted with an AWS managed KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:{{your-region}}:{{your-account-id}}:secret: [[secret-id]]" ] } ] } If your secret is encrypted with a customer managed AWS KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "arn:aws:secretsmanager:{{region}}:{{accountId}}:secret: {{secretId}}" }, { "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": "arn:aws:kms:{{region}}:{{accountId}}:key/{{keyId}}", "Condition": { "StringEquals": { "kms:ViaService": "secretsmanager.{{region}}.amazonaws.com" } CloudZero 62 Amazon Q Developer } } ] } User Guide To allow Amazon Q to assume the service role, the service role needs the following trust policy: Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "q.amazonaws.com" }, "Action": ["sts:AssumeRole", "sts:SetContext"], "Condition": { "StringEquals": { "aws:SourceAccount": "{{accountId}}", "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/ {{profileId}}" } } } ] } For more information about service roles, see Create a role to delegate permissions to an AWS service in the AWS Identity and Access Management User Guide. Conﬁgure the CloudZero plugin You conﬁgure plugins in the Amazon Q Developer console. Amazon Q uses credentials stored in AWS Secrets Manager to enable interactions with CloudZero. To conﬁgure the CloudZero plugin, complete the following procedure: CloudZero 63 Amazon Q Developer User Guide 1. Open the Amazon Q Developer console at https://console.aws.amazon.com/amazonq/ developer/home 2. On the Amazon Q Developer console home page, choose Settings. 3. In the navigation bar, choose Plugins. 4. On the plugins page, choose the plus sign on the CloudZero panel. The plugin conﬁguration page opens. 5. For Conﬁgure AWS Secrets Manager, choose either Create a new secret or Use an existing secret. The Secrets Manager secret is where your CloudZero authentication credentials will be stored. If you create a new secret, enter the following information: a. For CloudZero API key, enter the API key for your CloudZero organization. b. A service role will be created that Amazon Q will use to access the secret where your CloudZero credentials are stored. Do not edit the service role that is created for you. If you use an existing secret, choose a secret from the AWS Secrets Manager secret dropdown menu. The secret should include the CloudZero authentication credentials speciﬁed in the previous step. For more information about the required credentials, see Acquire credentials. 6. For Conﬁgure AWS IAM service role, choose either Create new service role or Use existing service role. Note If you chose Create a new secret for step 6, you can’t use an existing service role. A new role will be created for you. If you create a new service role, a service role will be created that Amazon Q will use to access the secret where your CloudZero credentials are stored. Do not edit the service role that is created for you. If you use an existing service role, choose a role from the dropdown menu that appears. Make sure your service role has the permissions and trust policy deﬁned in Service roles. CloudZero 64 Amazon Q Developer 7. Choose Save conﬁguration. User Guide 8. After the CloudZero plugin panel appears in the Conﬁgured plugins section on the Plugins page, users will have access to the plugin. If you want to update the credentials for a plugin, you must delete your current plugin and conﬁgure a new one. Deleting a plugin removes all previous speciﬁcations. Any time you conﬁgure a new plugin, a new plugin ARN is generated. Conﬁgure user permissions To use plugins, the following permissions are required: • Permissions to chat with Amazon Q in the console. For an example IAM policy that grants permissions needed to chat, see Allow users to chat with Amazon Q. • The q:UsePlugin permission. When you grant an IAM identity access to a conﬁgured CloudZero plugin, the identity gains access
amazonq-developer-ug-027	amazonq-developer-ug.pdf	27	you want to update the credentials for a plugin, you must delete your current plugin and conﬁgure a new one. Deleting a plugin removes all previous speciﬁcations. Any time you conﬁgure a new plugin, a new plugin ARN is generated. Conﬁgure user permissions To use plugins, the following permissions are required: • Permissions to chat with Amazon Q in the console. For an example IAM policy that grants permissions needed to chat, see Allow users to chat with Amazon Q. • The q:UsePlugin permission. When you grant an IAM identity access to a conﬁgured CloudZero plugin, the identity gains access to any resources in the CloudZero account retrievable by the plugin. CloudZero user permissions are not detected by the plugin. If you want to control access to a plugin, you can do so by specifying the plugin ARN in an IAM policy. Each time you create or delete and re-conﬁgure a plugin, it is assigned a new ARN. If you use a plugin ARN in a policy, it will need to be updated if you want to grant access to the newly conﬁgured plugin. To locate the CloudZero plugin ARN, go to the Plugins page in the Amazon Q Developer console and choose the conﬁgured CloudZero plugin. On the plugin details page, copy the plugin ARN. You can add this ARN to a policy to allow or deny access to the CloudZero plugin. If you create a policy to control access to CloudZero plugins, specify CloudZero for the plugin provider in the policy. For examples of IAM policies that control plugin access, see Allow users to chat with plugins from one provider. CloudZero 65 Amazon Q Developer User Guide Chat with the CloudZero plugin To use the CloudZero plugin, enter @cloudzero at the beginning of a question about CloudZero or your AWS application monitors and cases. Follow up questions or responses to questions from Amazon Q must also include @cloudzero. Following are some example use cases and associated questions you can ask to get the most of out of the Amazon Q CloudZero plugin: • Learn about using CloudZero with AWS – Ask about how CloudZero features work. Amazon Q might ask you for more information about what you’re trying to do to provide the best answer. • @cloudzero how do I use CloudZero? • @cloudzero how do I get started with CloudZero? • List cost insights – Get a list of cost insights or ﬁnd out more about a speciﬁc insight. • @cloudzero list my top cost insights • @cloudzero tell me more about insight <insight ID> • Get billing information – Ask the Amazon Q CloudZero plugin about your AWS billing information. • @cloudzero what were my AWS costs for December 2024? Conﬁguring the Amazon Q Developer Datadog plugin Datadog is a monitoring and security platform that provides infrastructure, application, and network monitoring and analytics. If you use Datadog to monitor your AWS applications, you can use the Datadog plugin in Amazon Q Developer chat to access monitoring information without leaving the AWS Management Console. You can use the Datadog plugin to learn about Datadog, understand how it works with AWS services, and ask about your Datadog cases and monitors. After you receive a response, you can ask follow up questions, including how to address an issue or for details about Datadog resources. To conﬁgure the plugin, you provide authentication credentials from your Datadog account to enable a connection between Amazon Q and Datadog. After you conﬁgure the plugin, you can access Datadog metrics by adding @datadog to the beginning of your question in Amazon Q chat. Datadog 66 Amazon Q Developer Warning User Guide Datadog user permissions are not detected by the Datadog plugin in Amazon Q. When an administrator conﬁgures the Datadog plugin in an AWS account, users with plugin permissions in that account have access to any resources in the Datadog account retrievable by the plugin. You can conﬁgure IAM policies to restrict which plugins users have access to. For more information, see Conﬁgure user permissions. Prerequisites Add permissions To conﬁgure plugins, the following administrator level permissions are required: • Permissions to access the Amazon Q Developer console. For an example IAM policy that grants needed permissions, see Allow administrators to use the Amazon Q Developer console. • Permissions to conﬁgure plugins. For an example IAM policy that grants the needed permissions, see Allow administrators to conﬁgure plugins. Acquire credentials Before you begin, note the following information from your Datadog account. These authentication credentials will be stored in an AWS Secrets Manager secret when you conﬁgure the plugin. • Site parameter – The Datadog site parameter you use. For example, us3.datadoghq.com. For more information, see Getting Started with Datadog Sites in the Datadog documentation. • API key and application key – Access keys that allow
amazonq-developer-ug-028	amazonq-developer-ug.pdf	28	needed permissions, see Allow administrators to use the Amazon Q Developer console. • Permissions to conﬁgure plugins. For an example IAM policy that grants the needed permissions, see Allow administrators to conﬁgure plugins. Acquire credentials Before you begin, note the following information from your Datadog account. These authentication credentials will be stored in an AWS Secrets Manager secret when you conﬁgure the plugin. • Site parameter – The Datadog site parameter you use. For example, us3.datadoghq.com. For more information, see Getting Started with Datadog Sites in the Datadog documentation. • API key and application key – Access keys that allow Amazon Q to call the Datadog API to access events and metrics. You can ﬁnd these under Organization Settings in your Datadog account. For more information, see API and Application Keys in the Datadog documentation. Datadog 67 Amazon Q Developer Secrets and service roles AWS Secrets Manager secret User Guide When you conﬁgure the plugin, Amazon Q creates a new AWS Secrets Manager secret for you to store Datadog authentication credentials. Alternatively, you can use an existing secret that you create yourself. If you create a secret yourself, make sure it includes the following credentials and uses the following JSON format: { "ApiKey": "<your-api-key>", "AppKey": "<your-applicaiton-key>" } For more information about creating secrets, see Create a secret in the AWS Secrets Manager User Guide. Service roles To conﬁgure the Datadog plugin in Amazon Q Developer, you need to create a service role that gives Amazon Q permission to access your Secrets Manager secret. Amazon Q assumes this role to access the secret where your Datadog credentials are stored. When you conﬁgure the plugin in the AWS console, you have the option to create a new secret or use an existing one. If you create a new secret, the associated service role is created for you. If you use an existing secret and an existing service role, make sure your service role contains the following permissions, and has the following trust policy attached. The service role required depends on your secret encryption method. If your secret is encrypted with an AWS managed KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ Datadog 68 Amazon Q Developer User Guide "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:{{your-region}}:{{your-account-id}}:secret: [[secret-id]]" ] } ] } If your secret is encrypted with a customer managed AWS KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "arn:aws:secretsmanager:{{region}}:{{accountId}}:secret: {{secretId}}" }, { "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": "arn:aws:kms:{{region}}:{{accountId}}:key/{{keyId}}", "Condition": { "StringEquals": { "kms:ViaService": "secretsmanager.{{region}}.amazonaws.com" } } } ] } To allow Amazon Q to assume the service role, the service role needs the following trust policy: Datadog 69 Amazon Q Developer Note User Guide The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "q.amazonaws.com" }, "Action": ["sts:AssumeRole", "sts:SetContext"], "Condition": { "StringEquals": { "aws:SourceAccount": "{{accountId}}", "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/ {{profileId}}" } } } ] } For more information about service roles, see Create a role to delegate permissions to an AWS service in the AWS Identity and Access Management User Guide. Conﬁgure the Datadog plugin You conﬁgure plugins in the Amazon Q Developer console. Amazon Q uses credentials stored in AWS Secrets Manager to enable interactions with Datadog. To conﬁgure the Datadog plugin, complete the following procedure: 1. Open the Amazon Q Developer console at https://console.aws.amazon.com/amazonq/ developer/home 2. On the Amazon Q Developer console home page, choose Settings. 3. In the navigation bar, choose Plugins. Datadog 70 Amazon Q Developer User Guide 4. On the plugins page, choose the plus sign on the Datadog panel. The plugin conﬁguration 5. 6. page opens. For Site URL, enter the URL of the Datadog site you use. For Conﬁgure AWS Secrets Manager, choose either Create a new secret or Use an existing secret. The Secrets Manager secret is where your Datadog authentication credentials will be stored. If you create a new secret, enter the following information: a. b. c. For Datadog API key, enter the API key for your Datadog organization. For Datadog application key, enter the application key for your Datadog account. A service role will be created that Amazon Q will use to access the secret where your Datadog credentials are stored. Do not edit the service role that is created for you. If you use an existing secret, choose a secret from the AWS Secrets Manager secret dropdown menu. The secret should include the Datadog authentication credentials speciﬁed in the previous step. For more information about the required credentials, see Acquire credentials . 7. For Conﬁgure AWS IAM service role,
amazonq-developer-ug-029	amazonq-developer-ug.pdf	29	enter the API key for your Datadog organization. For Datadog application key, enter the application key for your Datadog account. A service role will be created that Amazon Q will use to access the secret where your Datadog credentials are stored. Do not edit the service role that is created for you. If you use an existing secret, choose a secret from the AWS Secrets Manager secret dropdown menu. The secret should include the Datadog authentication credentials speciﬁed in the previous step. For more information about the required credentials, see Acquire credentials . 7. For Conﬁgure AWS IAM service role, choose either Create new service role or Use existing service role. Note If you chose Create a new secret for step 6, you can’t use an existing service role. A new role will be created for you. If you create a new service role, a service role will be created that Amazon Q will use to access the secret where your Datadog credentials are stored. Do not edit the service role that is created for you. If you use an existing service role, choose a role from the dropdown menu that appears. Make sure your service role has the permissions and trust policy deﬁned in Service roles. 8. Choose Save conﬁguration. Datadog 71 Amazon Q Developer User Guide 9. After the Datadog plugin panel appears in the Conﬁgured plugins section on the Plugins page, users will have access to the plugin. If you want to update the credentials for a plugin, you must delete your current plugin and conﬁgure a new one. Deleting a plugin removes all previous speciﬁcations. Any time you conﬁgure a new plugin, a new plugin ARN is generated. Conﬁgure user permissions To use plugins, the following permissions are required: • Permissions to chat with Amazon Q in the console. For an example IAM policy that grants permissions needed to chat, see Allow users to chat with Amazon Q. • The q:UsePlugin permission. When you grant an IAM identity access to a conﬁgured Datadog plugin, the identity gains access to any resources in the Datadog account retrievable by the plugin. Datadog user permissions are not detected by the plugin. If you want to control access to a plugin, you can do so by specifying the plugin ARN in an IAM policy. Each time you create or delete and re-conﬁgure a plugin, it is assigned a new ARN. If you use a plugin ARN in a policy, it will need to be updated if you want to grant access to the newly conﬁgured plugin. To locate the Datadog plugin ARN, go to the Plugins page in the Amazon Q Developer console and choose the conﬁgured Datadog plugin. On the plugin details page, copy the plugin ARN. You can add this ARN to a policy to allow or deny access to the Datadog plugin. If you create a policy to control access to Datadog plugins, specify Datadog for the plugin provider in the policy. For examples of IAM policies that control plugin access, see Allow users to chat with plugins from one provider. Chat with the Datadog plugin To use the Datadog plugin, enter @datadog at the beginning of a question about Datadog or your AWS application monitors and cases. Follow up questions or responses to questions from Amazon Q must also include @datadog. Datadog 72 Amazon Q Developer User Guide Following are some example use cases and associated questions you can ask to get the most of out of the Amazon Q Datadog plugin: • Learn about using Datadog features in your AWS workload – Ask about how Datadog features work with certain AWS services. Amazon Q might ask you for more information about what you’re trying to do to provide the best answer. • @datadog how do I use APM on EC2? • Retrieve and summarize cases and monitors – Ask about a speciﬁc case or monitor, or specify properties to get information about monitors and cases like create date, status, or author. For more information about properties, see Properties in the Datadog documentation. • @datadog summarize the global outage case • @datadog summarize my top cases • Check monitors that are in an alarm state – Ask the Amazon Q Datadog plugin to ﬁnd your AWS application monitors that are in alarm. You can follow up with questions about the monitors it lists. • @datadog what monitors are in alarm? • @datadog what is the status for monitor <monitor ID>? Conﬁguring the Amazon Q Developer Wiz plugin Wiz is a cloud security platform that provides security posture management, risk assessment and prioritization, and vulnerability management. If you use Wiz to evaluate and monitor your AWS applications, you can use the plugin in Amazon Q chat to access insights from Wiz without leaving the AWS Management Console.
amazonq-developer-ug-030	amazonq-developer-ug.pdf	30	Ask the Amazon Q Datadog plugin to ﬁnd your AWS application monitors that are in alarm. You can follow up with questions about the monitors it lists. • @datadog what monitors are in alarm? • @datadog what is the status for monitor <monitor ID>? Conﬁguring the Amazon Q Developer Wiz plugin Wiz is a cloud security platform that provides security posture management, risk assessment and prioritization, and vulnerability management. If you use Wiz to evaluate and monitor your AWS applications, you can use the plugin in Amazon Q chat to access insights from Wiz without leaving the AWS Management Console. You can use the plugin to identify and retrieve Wiz issues, assess your riskiest assets, and understand vulnerabilities or exposures. After you receive a response, you can ask follow up questions, including how to remediate an issue. To conﬁgure the plugin, you provide authentication credentials from your Wiz account to enable a connection between Amazon Q and Wiz. After you conﬁgure the plugin, you can access Wiz metrics by adding @wiz to the beginning of your question in Amazon Q chat. Wiz 73 Amazon Q Developer Warning User Guide Wiz user permissions are not detected by the Wiz plugin in Amazon Q. When an administrator conﬁgures the Wiz plugin in an AWS account, users with plugin permissions in that account have access to any resources in the Wiz account retrievable by the plugin. You can conﬁgure IAM policies to restrict which plugins users have access to. For more information, see Conﬁgure user permissions. Prerequisites Add permissions To conﬁgure plugins, the following administrator level permissions are required: • Permissions to access the Amazon Q Developer console. For an example IAM policy that grants needed permissions, see Allow administrators to use the Amazon Q Developer console. • Permissions to conﬁgure plugins. For an example IAM policy that grants the needed permissions, see Allow administrators to conﬁgure plugins. Acquire credentials Before you begin, note the following information from your Wiz account. These authentication credentials will be stored in an AWS Secrets Manager secret when you conﬁgure the plugin. • API endpoint URL – The URL where you access Wiz. For example, https:// api.us1.app.Wiz.io/graphql. For more information, see API endpoint URL in the Wiz documentation. • Client ID and Client secret – Credentials that allow Amazon Q to call Wiz APIs to access your application. For more information, see Client ID and Client secret in the Wiz documentation. Secrets and service roles AWS Secrets Manager secret When you conﬁgure the plugin, Amazon Q creates a new AWS Secrets Manager secret for you to store Wiz authentication credentials. Alternatively, you can use an existing secret that you create yourself. Wiz 74 Amazon Q Developer User Guide If you create a secret yourself, make sure it includes the following credentials and uses the following JSON format: { "ClientId": "<your-client-id>", "ClientSecret": "<your-client-secret>" } For more information about creating secrets, see Create a secret in the AWS Secrets Manager User Guide. Service roles To conﬁgure the Wiz plugin in Amazon Q Developer, you need to create a service role that gives Amazon Q permission to access your Secrets Manager secret. Amazon Q assumes this role to access the secret where your Wiz credentials are stored. When you conﬁgure the plugin in the AWS console, you have the option to create a new secret or use an existing one. If you create a new secret, the associated service role is created for you. If you use an existing secret and an existing service role, make sure your service role contains these permissions, and has the following trust policy attached. The service role required depends on your secret encryption method. If your secret is encrypted with an AWS managed KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:{{your-region}}:{{your-account-id}}:secret: [[secret-id]]" ] } ] } Wiz 75 Amazon Q Developer User Guide If your secret is encrypted with a customer managed AWS KMS key, the following IAM service role is required: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": "arn:aws:secretsmanager:{{region}}:{{accountId}}:secret: {{secretId}}" }, { "Effect": "Allow", "Action": [ "kms:Decrypt" ], "Resource": "arn:aws:kms:{{region}}:{{accountId}}:key/{{keyId}}", "Condition": { "StringEquals": { "kms:ViaService": "secretsmanager.{{region}}.amazonaws.com" } } } ] } To allow Amazon Q to assume the service role, the service role needs the following trust policy: Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", Wiz 76 Amazon Q Developer User Guide "Principal": { "Service": "q.amazonaws.com" }, "Action": ["sts:AssumeRole", "sts:SetContext"], "Condition": { "StringEquals": { "aws:SourceAccount": "{{accountId}}", "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/ {{profileId}}" } } } ] } For more information about service roles, see
amazonq-developer-ug-031	amazonq-developer-ug.pdf	31	{ "StringEquals": { "kms:ViaService": "secretsmanager.{{region}}.amazonaws.com" } } } ] } To allow Amazon Q to assume the service role, the service role needs the following trust policy: Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", Wiz 76 Amazon Q Developer User Guide "Principal": { "Service": "q.amazonaws.com" }, "Action": ["sts:AssumeRole", "sts:SetContext"], "Condition": { "StringEquals": { "aws:SourceAccount": "{{accountId}}", "aws:SourceArn": "arn:aws:codewhisperer:{{region}}:{{accountId}}:profile/ {{profileId}}" } } } ] } For more information about service roles, see Create a role to delegate permissions to an AWS service in the AWS Identity and Access Management User Guide. Conﬁgure the Wiz plugin You conﬁgure plugins in the Amazon Q Developer console. Amazon Q uses credentials stored in AWS Secrets Manager to enable interactions with Wiz. To conﬁgure the Wiz plugin, complete the following procedure: 1. Open the Amazon Q Developer console at https://console.aws.amazon.com/amazonq/ developer/home 2. On the Amazon Q Developer console home page, choose Settings. 3. In the navigation bar, choose Plugins. 4. On the plugins page, choose the plus sign on the Wiz panel. The plugin conﬁguration page opens. 5. 6. For API endpoint URL, enter the URL of API endpoint where you access Wiz. For Conﬁgure AWS Secrets Manager, choose either Create a new secret or Use an existing secret. The Secrets Manager secret is where your Wiz authentication credentials will be stored. If you create a new secret, enter the following information: For Client ID, enter the Client ID for your Wiz account. For Client Secret, enter the Client Secret for your Wiz account. a. b. Wiz 77 Amazon Q Developer User Guide c. A service role will be created that Amazon Q will use to access the secret where your Wiz credentials are stored. Do not edit the service role that is created for you. If you use an existing secret, choose a secret from the AWS Secrets Manager secret dropdown menu. The secret should include the Wiz authentication credentials speciﬁed in the previous step. For more information about the required credentials, see Acquire credentials . 7. For Conﬁgure AWS IAM service role, choose either Create new service role or Use existing service role. Note If you chose Create a new secret for step 6, you can’t use an existing service role. A new role will be created for you. If you create a new service role, a service role will be created that Amazon Q will use to access the secret where your Wiz credentials are stored. Do not edit the service role that is created for you. If you use an existing service role, choose a role from the dropdown menu that appears. Make sure your service role has the permissions and trust policy deﬁned in Service roles. 8. Choose Save conﬁguration. 9. After the Wiz plugin panel appears in the Conﬁgured plugins section on the Plugins page, users will have access to the plugin. If you want to update the credentials for a plugin, you must delete your current plugin and conﬁgure a new one. Deleting a plugin removes all previous speciﬁcations. Any time you conﬁgure a new plugin, a new plugin ARN is generated. Conﬁgure user permissions To use plugins, the following permissions are required: • Permissions to chat with Amazon Q in the console. For an example IAM policy that grants permissions needed to chat, see Allow users to chat with Amazon Q. Wiz 78 Amazon Q Developer • The q:UsePlugin permission. User Guide When you grant an IAM identity access to a conﬁgured Wiz plugin, the identity gains access to any resources in the Wiz account retrievable by the plugin. Wiz user permissions are not detected by the plugin. If you want to control access to a plugin, you can do so by specifying the plugin ARN in an IAM policy. Each time you create or delete and re-conﬁgure a plugin, it is assigned a new ARN. If you use a plugin ARN in a policy, it will need to be updated if you want to grant access to the newly conﬁgured plugin. To locate the Wiz plugin ARN, go to the Plugins page in the Amazon Q Developer console and choose the conﬁgured Wiz plugin. On the plugin details page, copy the plugin ARN. You can add this ARN to a policy to allow or deny access to the Wiz plugin. If you create a policy to control access to Wiz plugins, specify Wiz for the plugin provider in the policy. For examples of IAM policies that control plugin access, see Allow users to chat with plugins from one provider. Chat with the Wiz plugin To use the Amazon Q Wiz plugin, enter @Wiz at the beginning of
amazonq-developer-ug-032	amazonq-developer-ug.pdf	32	go to the Plugins page in the Amazon Q Developer console and choose the conﬁgured Wiz plugin. On the plugin details page, copy the plugin ARN. You can add this ARN to a policy to allow or deny access to the Wiz plugin. If you create a policy to control access to Wiz plugins, specify Wiz for the plugin provider in the policy. For examples of IAM policies that control plugin access, see Allow users to chat with plugins from one provider. Chat with the Wiz plugin To use the Amazon Q Wiz plugin, enter @Wiz at the beginning of a question about your Wiz issues. Follow up questions or responses to questions from Amazon Q must also include @Wiz. Following are some example use cases and associated questions you can ask to get the most of out of the Amazon Q Wiz plugin: • View issues with critical severity – Ask the Amazon Q Wiz plugin to list your issues with critical or high severity. The plugin can return up to 10 issues. You can also ask to list up to the top 10 most severe issues. • @wiz what are my critical severity issues? • @wiz can you specify the top 5? • List issues based on date or status – Ask to list issues based on create date, due date, or resolved date. You can also specify issues based on properties like status, severity, and type. • @wiz which issues are due before <date>? • @wiz what are my issues that have been resolved since <date>? Wiz 79 Amazon Q Developer User Guide • Assess issues with security vulnerabilities – Ask about the vulnerabilities or exposures that are posing security threats in your issues. • @wiz which issues are associated with vulnerabilities or external exposures? Automating AWS services with Amazon Q Developer Console- to-Code What is Console-to-Code? Console-to-Code is a feature of Amazon Q Developer that can help you write code to automate your use of other AWS services. Console-to-Code records your console actions, then uses generative AI to suggest code in your preferred language and format. Tiers of service Since Console-to-Code is a part of Amazon Q Developer, your use of it is subject to Amazon Q Developer’s tiers of service. • At the Free tier, there is no ﬁxed monthly limit to the number of times you can record your console actions and generate CLI commands based on those actions. However, there is a limit to how many times per month you can generate code to use with the AWS CDK or AWS CloudFormation based on your recorded actions. To access the Free tier, sign into the AWS Management Console. After you reach the monthly code generations limit, you must authenticate to the Pro tier in order to generate more code. • At the Pro tier, there is no ﬁxed monthly limit to the number of times you can generate code for the AWS CDK or CloudFormation. To access the Pro tier, you must be a user registered with IAM Identity Center, and your IAM Identity Center identity must be subscribed to Amazon Q Developer Pro. For more information, see Authenticating to your Amazon Q Developer Pro subscription or contact your AWS administrator. For more information on pricing tiers, visit the Amazon Q Developer pricing page. Console-to-Code 80 Amazon Q Developer Note User Guide When you record an action, you will still be charged for the action itself, if applicable. For example, if you record yourself provisioning an Amazon EC2 instance, then you will still be charged for the instance. There is no additional cost for recording the action. Supported code formats Console-to-Code can currently generate infrastructure-as-code (IaC) in the following languages and formats: • CDK Java • CDK Python • CDK TypeScript • CloudFormation JSON • CloudFormation YAML Where can you use Console-to-Code? Using Console-to-Code across multiple services Console-to-Code works across multiple services, saving its own state for as long as your browser tab is open. For example, you may record your actions during a complete setup of a web server: • In the Amazon VPC console, you provision two subnets (one public and one private), security groups, NACLs, a custom routing table, and an internet gateway. • In the Amazon EC2 console, you provision an Amazon EC2 instance and place it in the public subnet. • In the Amazon RDS console, you provision an Amazon RDS DB instance and place it in the private subnet. Even if you perform your actions in diﬀerent parts of the console and they use diﬀerent AWS services, Console-to-Code can include them in a single recording. Where you can use Console-to-Code 81 Amazon Q Developer User Guide AWS services that support Console-to-Code Currently, Console-to-Code is available to record your actions when using the AWS management console with the
amazonq-developer-ug-033	amazonq-developer-ug.pdf	33	an internet gateway. • In the Amazon EC2 console, you provision an Amazon EC2 instance and place it in the public subnet. • In the Amazon RDS console, you provision an Amazon RDS DB instance and place it in the private subnet. Even if you perform your actions in diﬀerent parts of the console and they use diﬀerent AWS services, Console-to-Code can include them in a single recording. Where you can use Console-to-Code 81 Amazon Q Developer User Guide AWS services that support Console-to-Code Currently, Console-to-Code is available to record your actions when using the AWS management console with the following services: • Amazon EC2 • Amazon VPC • Amazon RDS Granting permissions to use Console-to-Code To use Console-to-Code, the following permissions are required: • q:GenerateCodeFromCommands to use Console-to-Code. For an example IAM policy that grants the needed permission, see Allow users to generate code from CLI commands with Amazon Q. • Permissions to take the actions that you're going to record. Using Console-to-Code Using Console-to-Code consists of three steps. Step 1: Start recording To start recording with Console-to-Code, use the following procedure. 1. Go to the console of one of the integrated services (Amazon VPC, Amazon RDS, or Amazon EC2). 2. On the right edge of the browser window, choose the Console-to-Code icon. 3. In the Console-to-Code side panel, choose Start recording. Step 2: Take actions In the consoles of any of the integrated services, proceed to take any actions that you want to record. Granting permissions 82 Amazon Q Developer User Guide The Console-to-Code side panel retains its own state. You can move between the consoles of the integrated services, creating one recording that involves actions for multiple services. The Console-to-Code side panel will retain your actions until your Console-to-Code session ends. The session will end when you close the browser tab, or when your AWS Management Console session ends, whichever comes ﬁrst. When you have ﬁnished taking actions that you want to convert to code, choose Stop from the top of the Console-to-Code panel. Step 3: Gather CLI commands and generating code You can follow either Step 3a or Step 3b. Step 3a: Gather CLI commands To use Console-to-Code to generate CLI commands based on your actions, use the following procedure. 1. In the Console-to-Code panel, review your recorded actions. You can ﬁlter the recorded actions using the dropdown, search box, or ﬁlter widget at the top of the Console-to-Code panel. 2. At the top of the Console-to-Code panel, toggle the Show CLI setting. This will display the CLI command corresponding to each selected action. 3. Select the commands that you want to use. Only the commands with checked boxes will be used in the following steps. 4. Consolidate the CLI commands. Near the bottom of the Console-to-Code panel, choose the accordion icon (^). The CLI commands that you selected will appear by themselves in the panel. 5. Copy or download your chosen commands. To learn more about the AWS CLI, see What is the AWS Command Line Interface? in the AWS Command Line Interface User Guide. Step 3b: Generate code 1. In the Console-to-Code panel, review your recorded actions. You can ﬁlter the recorded actions using the dropdown, search box, or ﬁlter widget at the top of the Console-to-Code panel. Using 83 Amazon Q Developer User Guide 2. Select the actions that you want to convert into code. Only the actions with checked boxes will be used in the following steps. 3. Indicate the type of code that you want to generate. From the reverse dropdown menu at the lower right of the Console-to-Code panel, select the language and (if applicable) format of the code to be generated. 4. Choose Generate chosen language. The generated code will appear, along with the equivalent CLI commands. Diagnosing common errors in the console with Amazon Q Developer In the AWS Management Console, Amazon Q Developer diagnoses common errors you encounter while working with AWS services, such as insuﬃcient permissions, incorrect conﬁguration, and exceeding service limits. Amazon Q troubleshoots errors you receive while using the following services in the AWS console: • Amazon Elastic Compute Cloud (Amazon EC2) • Amazon Elastic Container Service (Amazon ECS) • Amazon Simple Storage Service (Amazon S3) • AWS Lambda In addition, Amazon Q troubleshoots IAM permission errors across all AWS console pages and a limited number of service-speciﬁc errors for some AWS services. Amazon Q doesn't maintain a history of previous error diagnosing sessions. If you're unable to diagnose your error with Amazon Q, you can use Amazon Q to create a support case with Support. For more information, see Using Amazon Q Developer to chat with Support. If you have an issue speciﬁc to the Amazon Q error diagnosing feature, you can use the thumbs-down icon to report an issue. Add permissions For
amazonq-developer-ug-034	amazonq-developer-ug.pdf	34	(Amazon S3) • AWS Lambda In addition, Amazon Q troubleshoots IAM permission errors across all AWS console pages and a limited number of service-speciﬁc errors for some AWS services. Amazon Q doesn't maintain a history of previous error diagnosing sessions. If you're unable to diagnose your error with Amazon Q, you can use Amazon Q to create a support case with Support. For more information, see Using Amazon Q Developer to chat with Support. If you have an issue speciﬁc to the Amazon Q error diagnosing feature, you can use the thumbs-down icon to report an issue. Add permissions For an IAM policy that grants permissions needed for diagnosing console errors, see Allow users to diagnose console errors with Amazon Q. Diagnosing console errors 84 Amazon Q Developer User Guide Diagnose common errors in the console To use Amazon Q to diagnose an error in the AWS Management Console, use the following procedure. 1. If you receive an error that Amazon Q can help you with, a Diagnose with Amazon Q button appears in the error message. If you want to use Amazon Q to diagnose the error, choose Diagnose with Amazon Q to proceed. 2. A window appears where Amazon Q ﬁrst provides information about the error. It then provides a series of steps you can take to resolve the error. It can take several seconds for Amazon Q to generate instructions. 3. To provide feedback, you can use the thumbs-up and thumbs-down icons. To provide detailed feedback, choose the Tell me more button that appears after you select an icon. Using Amazon Q Developer to chat with Support You can use Amazon Q Developer to create a support case and contact Support from anywhere in the AWS Management Console, including the AWS Support Center Console. Amazon Q uses the context of your conversation to draft a support case on your behalf automatically. It also adds your recent conversation to the support case description. After creating the case, Amazon Q can transfer you to a support agent in the method of your choice, including live chat in the same interface. When you create a support case in Amazon Q, the case is also updated in the Support Center Console. To track updates on cases created with Amazon Q, use the Support Center Console. The type of Support available to you depends on the support plan for your AWS account. All AWS users have access to account and billing support as part of the Basic Support plan. For technical support questions, only users with support plans other than the Basic Support plan can contact Support with Amazon Q. For more information about AWS Support, see Getting started with AWS Support in the AWS Support User Guide. Tip Before you create a support ticket, try asking Amazon Q to resolve the issue. For more information, see Asking Amazon Q to troubleshoot your resources. You can also try the Diagnose with Amazon Q button, if it's available. For more information, see Diagnosing console errors. Diagnose common errors in the console 85 Amazon Q Developer Prerequisites User Guide To create cases in Amazon Q, you must meet the following requirements: • You have a support plan higher than the Basic Support plan. Only users with support plans other than the Basic Support plan can contact Support with Amazon Q. • You have permissions to chat with Amazon Q. For more information, see Allow users to chat with Amazon Q. • You have permissions to create Support cases. For more information, see Manage access to Support Center. Specify the right service When you create a support case with Amazon Q, it populates the service ﬁeld based on your question. If Amazon Q chooses the wrong service, update the case with the correct service. If your question has to do with multiple services, specify the service that's most applicable. To contact Support about an Amazon Q feature that is part of another AWS service, create a support case for the other AWS service, not for Amazon Q. For example, if you're using Amazon Q network troubleshooting in Amazon VPC Reachability Analyzer, choose Amazon VPC for the service in the support case. To contact Support about features in either Amazon Q Developer or Amazon Q Business, create a support case for Amazon Q. Create a support case To create an Support case with Amazon Q, use the following steps. 1. You can create an Support case through Amazon Q in one of two ways: a. Ask for help directly by entering a question such as “I want to speak to someone” or “Get support”. To provide more context for Amazon Q to create the support case, you can add more information when requesting support directly. Following is an example of providing more information in a request:
amazonq-developer-ug-035	amazonq-developer-ug.pdf	35	features in either Amazon Q Developer or Amazon Q Business, create a support case for Amazon Q. Create a support case To create an Support case with Amazon Q, use the following steps. 1. You can create an Support case through Amazon Q in one of two ways: a. Ask for help directly by entering a question such as “I want to speak to someone” or “Get support”. To provide more context for Amazon Q to create the support case, you can add more information when requesting support directly. Following is an example of providing more information in a request: Prerequisites 86 Amazon Q Developer User Guide "I am unable to connect to my bastion instance. I have tried restarting it and generating new key pairs but still nothing works. This started this morning after a planned deployment. I can conﬁrm that no other network related changes were made. Can I talk to someone?" b. If an Amazon Q response didn’t help you, choose the thumbs-down icon on the response and then choose a reason that you're providing the feedback. To contact Support, choose Create a support case. The following image shows the Create a support case button in the Amazon Q chat panel that appears after you leave feedback. 2. A support case appears in the chat panel. If you had a conversation with Amazon Q before requesting support, it will use the context of your conversation to autopopulate the ﬁelds in the case. To update any ﬁeld in the support case, choose Edit. You can also attach ﬁles that help explain your issue. If you didn't chat with Amazon Q before requesting support or Amazon Q otherwise can’t complete the ﬁelds in the support case, you can input your support case information into the case manually. The following image is an example of a ﬁlled-out support case in the Amazon Q chat panel. Create a support case 87 Amazon Q Developer User Guide 3. After conﬁrming that the support case describes your needs, choose Submit to create the support case. If you no longer want to create the case, choose Cancel. 4. To contact Support, choose the method that you want to use. Depending on your case details, you can chat, email, or request a phone call from a live support agent: a. Chat – If you choose to chat with an agent, a live support agent will enter the conversation. To end the chat with the support agent, choose End this chat at any time during the chat. If you refresh your page, navigate to a diﬀerent console, or get signed out of the console because of session expiration, the conversation will end. Create a support case 88 Amazon Q Developer User Guide If you minimize the chat panel or leave the page, you might miss notiﬁcations and be disconnected because of inactivity. We recommend that you keep the chat panel open throughout the duration of your support chat. b. c. Email – If you choose to send an email message to an agent, a support agent will contact you at the email address that's associated with your AWS account. Call – If you choose to call an agent, enter your phone number when prompted, and choose Submit. You will be added to the call queue. 5. You can leave feedback or choose Skip to return to the Amazon Q chat panel. Leave feedback After the support chat has ended, you can optionally leave feedback. Rate your experience, enter any additional feedback, and then choose Submit feedback. Leave feedback 89 Amazon Q Developer User Guide Using Amazon Q Developer in the IDE Use Amazon Q Developer in integrated development environments (IDEs) to learn about AWS and get assistance with your software development needs. In IDEs, Amazon Q includes capabilities to provide guidance and support across various aspects of software development, such as answering questions about building on AWS, generating and updating code, security scanning, and optimizing and refactoring code. To install Amazon Q in your IDE, see Installing the Amazon Q Developer extension or plugin in your IDE. Topics • Supported IDEs and available features • Installing the Amazon Q Developer extension or plugin in your IDE • Chatting with Amazon Q Developer about code • Generating inline suggestions with Amazon Q Developer • Transforming code in the IDE with Amazon Q Developer • Developing features with Amazon Q Developer • Generating unit tests with Amazon Q • Reviewing code with Amazon Q Developer • Generating documentation with Amazon Q Developer • Supported languages for Amazon Q Developer in the IDE Supported IDEs and available features The features you have access to depend on the IDE where you use Amazon Q. The following table describes the IDEs supported by Amazon Q and the availability and limitations of
amazonq-developer-ug-036	amazonq-developer-ug.pdf	36	• Chatting with Amazon Q Developer about code • Generating inline suggestions with Amazon Q Developer • Transforming code in the IDE with Amazon Q Developer • Developing features with Amazon Q Developer • Generating unit tests with Amazon Q • Reviewing code with Amazon Q Developer • Generating documentation with Amazon Q Developer • Supported languages for Amazon Q Developer in the IDE Supported IDEs and available features The features you have access to depend on the IDE where you use Amazon Q. The following table describes the IDEs supported by Amazon Q and the availability and limitations of features in each IDE. If no language support is speciﬁed, the IDE supports languages listed in the Supported languages topic. IDE Supported features Eclipse IDEs (Preview) Chat Supported IDEs 90 Amazon Q Developer User Guide IDE Supported features Inline chat Inline suggestions Customizations JetBrains IDEs Chat Inline chat Workspace context in chat Inline suggestions Transformations (/transform) Feature development (/dev) Unit test generation (/test) Code reviews (/review) Documentation generation (/doc) Customizations Supported IDEs 91 Amazon Q Developer User Guide IDE Supported features Visual Studio Code Chat Inline chat Context in chat Inline suggestions Transformations (/transform) Feature development (/dev) Unit test generation (/test) Code reviews (/review) Documentation generation (/doc) Customizations Visual Studio Chat Inline suggestions Transformations Code reviews – C# AWS coding environments Inline suggestions Installing the Amazon Q Developer extension or plugin in your IDE To set up Amazon Q Developer in your integrated development environment (IDE), complete the following steps. After installing the Amazon Q extension or plugin, authenticate through IAM Identity Center or AWS Builder ID. You can use Amazon Q for free, without an AWS account, by authenticating with Builder ID. Installing Amazon Q 92 Amazon Q Developer User Guide To get started, download the Amazon Q extension or plugin for your IDE: • Download Amazon Q for Eclipse (Preview) • Download Amazon Q for Visual Studio Code • Download Amazon Q for JetBrains IDEs • Download Amazon Q in the AWS Toolkit for Visual Studio Note In general, the default duration for a session that is authenticated through IAM Identity Center is 8 hours. However, in the case of Amazon Q, the default session lasts 90 days (if you set up IAM Identity Center on April 18, 2024 or later). For more information refer to How to extend the session duration for Amazon Q in the IDE in the IAM Identity Center User Guide. To sign in and authenticate, complete the steps in this section. Steps • Prerequisite: Supported IDE versions • Authenticating in Eclipse IDEs (Preview) • Authenticating in JetBrains IDEs • Authenticating in Visual Studio Code • Authenticating in Visual Studio • Using an IAM principal in your AWS console Prerequisite: Supported IDE versions • The minimum version of Eclipse supported by Amazon Q is 2024-06 (4.32). • The minimum version of JetBrains IDEs (including IntelliJ and PyCharm) supported by Amazon Q is 232.1. • The minimum version of Visual Studio Code supported by Amazon Q is 1.85.0. Supported IDE versions 93 Amazon Q Developer User Guide • Only Visual Studio for Windows is supported by Amazon Q. The minimum version of Visual Studio supported is Visual Studio 2022 version 17.7. All Visual Studio 2022 editions are supported. Authenticating in Eclipse IDEs (Preview) You can authenticate for free with AWS Builder ID or with IAM Identity Center with a Amazon Q Developer Pro subscription. Choose your authentication method to see steps to start using Amazon Q in Eclipse. Builder ID This procedure does not require you to have Builder ID. If you have not yet signed up for Builder ID, you will have the opportunity to do so during the sign-in process. 1. Install the Amazon Q plugin in Eclipse. 2. Choose the Amazon Q icon in the top right corner of the IDE. 3. An Amazon Q tab opens at the bottom of the IDE. Under Choose a sign-in option, choose Use for free, and then choose Continue. You are redirected to your browser. 4. Follow the instructions in your browser to authenticate with Builder ID. When you've completed authentication, return to the Eclipse IDE. 5. To begin using Amazon Q, choose the Amazon Q icon to open the chat Amazon Q panel. Amazon Q Developer Pro license Before you begin this procedure, your administrator should have: • Created an identity for you in IAM Identity Center • Subscribed that identity to Amazon Q Developer Pro After your identity has been subscribed to Amazon Q Developer Pro, complete the following steps to authenticate: 1. Install the Amazon Q plugin in Eclipse. 2. Choose the Amazon Q icon in the top right corner of the IDE. In Eclipse IDEs 94 Amazon Q Developer User Guide 3. An Amazon Q tab opens at the bottom of
amazonq-developer-ug-037	amazonq-developer-ug.pdf	37	Q icon to open the chat Amazon Q panel. Amazon Q Developer Pro license Before you begin this procedure, your administrator should have: • Created an identity for you in IAM Identity Center • Subscribed that identity to Amazon Q Developer Pro After your identity has been subscribed to Amazon Q Developer Pro, complete the following steps to authenticate: 1. Install the Amazon Q plugin in Eclipse. 2. Choose the Amazon Q icon in the top right corner of the IDE. In Eclipse IDEs 94 Amazon Q Developer User Guide 3. An Amazon Q tab opens at the bottom of the IDE. Under Choose a sign-in option, choose Use with Pro license, and then choose Continue. 4. Enter the Start URL that your administrator got from the Amazon Q subscription console. 5. Choose the AWS Region in which your administrator set up your IAM Identity Center instance. 6. Choose Continue. You are redirected to your browser. 7. Follow the instructions in your browser to authenticate with IAM Identity Center. When you've completed authentication, return to the Eclipse IDE. 8. To begin using Amazon Q, choose the Amazon Q icon to open the chat Amazon Q panel. Authenticating in JetBrains IDEs You can authenticate for free with AWS Builder ID or with IAM Identity Center with a Amazon Q Developer Pro subscription. Choose your authentication method to see steps to start using Amazon Q in your JetBrains IDE. Builder ID This procedure does not require you to have Builder ID. If you have not yet signed up for Builder ID, you will have the opportunity to do so during the sign-in process. 1. Install the Amazon Q plugin in your JetBrains IDE. 2. Choose the Amazon Q icon in your IDE. 3. 4. The icon will be on the side of the interface by default. Follow the instructions in your browser to authenticate with Builder ID. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose Amazon Q from the navigation bar at the bottom of your IDE. Amazon Q Developer Pro license Before you begin this procedure, your administrator should have: • Created an identity for you in IAM Identity Center • Subscribed that identity to Amazon Q Developer Pro In JetBrains IDEs 95 Amazon Q Developer User Guide After your identity has been subscribed to Amazon Q Developer Pro, complete the following steps to authenticate: 1. Install the Amazon Q plugin in your JetBrains IDE. 2. Choose the Amazon Q icon in your IDE. The icon will be on the side of the interface by default. 3. Choose Use with Pro license. 4. 5. Fill in the Start URL that your administrator got from the Amazon Q subscription console. Fill in the AWS Region in which your administrator set up your IAM Identity Center instance. 6. Choose Continue. The focus will switch to your web browser. 7. Follow the instructions in your browser to authenticate with IAM Identity Center, and then return to the IDE. 8. If your administrator has conﬁgured more than one Amazon Q Developer proﬁle, you will see the proﬁles you have access to. Choose the proﬁle that meets your current working needs, or that your administrator has instructed you to use. For more information about proﬁles, see Amazon Q Developer proﬁles. If there is only one proﬁle available, that proﬁle will automatically be chosen and you can begin using Amazon Q. To change your Amazon Q Developer proﬁle, choose Amazon Q from the bottom of the IDE, and then choose Change proﬁle. From the window that appears, choose the proﬁle you'd like to use. 9. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose Amazon Q from the navigation bar at the bottom of your IDE. Authenticating in Visual Studio Code You can authenticate for free with AWS Builder ID or with IAM Identity Center with a Amazon Q Developer Pro subscription. Choose your authentication method to see steps to start using Amazon Q in VS Code. In Visual Studio Code 96 Amazon Q Developer Builder ID User Guide This procedure does not require you to have Builder ID. If you have not yet signed up for Builder ID, you will have the opportunity to do so during the sign-in process. 1. Install the Amazon Q extension in VS Code. 2. Choose the Amazon Q icon in your IDE. 3. 4. The icon will be on the side of the interface by default. Follow the instructions in your browser to authenticate with Builder ID. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose Amazon Q from the navigation bar at the bottom of your IDE. Amazon Q Developer Pro license Before you
amazonq-developer-ug-038	amazonq-developer-ug.pdf	38	you have not yet signed up for Builder ID, you will have the opportunity to do so during the sign-in process. 1. Install the Amazon Q extension in VS Code. 2. Choose the Amazon Q icon in your IDE. 3. 4. The icon will be on the side of the interface by default. Follow the instructions in your browser to authenticate with Builder ID. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose Amazon Q from the navigation bar at the bottom of your IDE. Amazon Q Developer Pro license Before you begin this procedure, your administrator should have: • Created an identity for you in IAM Identity Center • Subscribed that identity to Amazon Q Developer Pro After your identity has been subscribed to Amazon Q Developer Pro, complete the following steps to authenticate: 1. Install the Amazon Q extension in VS Code. 2. Choose the Amazon Q icon in your IDE. The icon will be on the side of the interface by default. 3. Choose Use with Pro license. 4. 5. Fill in the Start URL that your administrator got from the Amazon Q subscription console. Fill in the AWS Region in which your administrator set up your IAM Identity Center instance. 6. Choose Continue. The focus will switch to your web browser. 7. Follow the instructions in your browser to authenticate with IAM Identity Center, and then return to the IDE. 8. If your administrator has conﬁgured more than one Amazon Q Developer proﬁle, you will see the proﬁles you have access to. Choose the proﬁle that meets your current working In Visual Studio Code 97 Amazon Q Developer User Guide needs, or that your administrator has instructed you to use. For more information about proﬁles, see Amazon Q Developer proﬁles. If there is only one proﬁle available, that proﬁle will automatically be chosen and you can begin using Amazon Q. To change your Amazon Q Developer proﬁle, choose Amazon Q from the bottom of the IDE, and then choose Change proﬁle. From the command palette, choose the proﬁle you'd like to use. 9. To begin using Amazon Q, choose the Amazon Q icon to chat with Amazon Q, or choose Amazon Q from the navigation bar at the bottom of your IDE. Authenticating in Visual Studio To connect to your AWS accounts from the Toolkit for Visual Studio, open the Getting Started with the AWS Toolkit User Interface (connection UI) by completing the following procedure. 1. 2. 3. From the Visual Studio main menu, expand Extensions then expand the AWS Toolkit. From the AWS Toolkit menu options choose Getting Started. The Getting Started with the AWS Toolkit connection UI opens in Visual Studio. You can authenticate for free with AWS Builder ID or with IAM Identity Center with a Amazon Q Developer Pro subscription. Choose your authentication method to see steps to start using Amazon Q in Visual Studio. Builder ID 1. From Visual Studio, expand Extensions from the main menu and then expand the AWS Toolkit sub-menu. 2. Choose Getting started. The Getting Started tab opens in the Visual Studio editor window. 3. 4. In the Amazon Q section, choose Enable. From the Free Tier section, choose the Sign up or Sign in button. 5. Conﬁrm that you want to open the AWS Authorize request portal in your default web browser. 6. Follow the prompts in your default web browser. You're notiﬁed when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. In Visual Studio 98 Amazon Q Developer Amazon Q Developer Pro license User Guide 1. From Visual Studio, expand Extensions from the main menu and then expand the AWS Toolkit sub-menu. 2. Choose Getting started. The Getting Started tab opens in the Visual Studio editor window. 3. In the Amazon Q section, choose Enable. You will ﬁll out the Professional Tier section to authenticate. 4. The credentials proﬁle is made up of the Proﬁle Name, Start URL, Proﬁle Region, or SSO Region provided by an administrator at your company or organization. For detailed information about IAM Identity Center credentials, see What is IAM Identity Center? in the IAM Identity Center User Guide. If you have an existing credentials proﬁle, choose it from the dropdown menu in the Professional tier panel, and then choose Connect. To create a new credentials proﬁle, ﬁll out the following ﬁelds from the Professional tier section: a. b. c. d. In the Proﬁle Name text ﬁeld, enter the name of the IAM Identity Center proﬁle you want to authenticate with. In the Start URL text ﬁeld, enter the start URL that's attached to your IAM Identity Center credentials. From the Proﬁle Region (defaults to us-east-1) drop-down menu, choose the AWS Region that's deﬁned
amazonq-developer-ug-039	amazonq-developer-ug.pdf	39	IAM Identity Center User Guide. If you have an existing credentials proﬁle, choose it from the dropdown menu in the Professional tier panel, and then choose Connect. To create a new credentials proﬁle, ﬁll out the following ﬁelds from the Professional tier section: a. b. c. d. In the Proﬁle Name text ﬁeld, enter the name of the IAM Identity Center proﬁle you want to authenticate with. In the Start URL text ﬁeld, enter the start URL that's attached to your IAM Identity Center credentials. From the Proﬁle Region (defaults to us-east-1) drop-down menu, choose the AWS Region that's deﬁned by the IAM Identity Center user proﬁle you're authenticating with. From the SSO Region (defaults to us-east-1) drop-down menu, choose the SSO Region that's deﬁned by your IAM Identity Center credentials, then choose the Connect button to open the Log in with AWS IAM Identity Center dialog. 5. Conﬁrm that you want to open the AWS Authorize request portal in your default web browser. 6. Follow the prompts in your default web browser. You're notiﬁed when the authorization process is complete, and it's safe to close your browser and return to Visual Studio. 7. A Sign into Amazon Q window appears. In the credentials proﬁle dropdown, choose the proﬁle you used to authenticate in the previous steps. 8. If your administrator has conﬁgured more than one Amazon Q Developer proﬁle, you are then prompted to choose a Q Developer proﬁle from the dropdown menu. Choose the In Visual Studio 99 Amazon Q Developer User Guide proﬁle that meets your current working needs, or that your administrator has instructed you to use. For more information about proﬁles, see Amazon Q Developer proﬁles. If there is only one proﬁle available, that proﬁle will automatically be chosen and you can begin using Amazon Q. To change your Amazon Q Developer proﬁle, choose Amazon Q from the bottom of the IDE, and then choose Change Q Developer Proﬁle. From the window that appears, choose the proﬁle you'd like to use. You can also change your proﬁle by choosing the overﬂow menu at the top right corner of the chat window, and then choosing Change Q Developer Proﬁle. For more information about authenticating in the Toolkit for Visual Studio, see Getting Started in the AWS Toolkit for Visual Studio User Guide. Using an IAM principal in your AWS console Depending on how you use AWS, you may be accustomed to using your IAM credentials to sign in to the console for all AWS services. However, you cannot use Amazon Q Developer in the IDE as an IAM principal, or with an IAM role. You must authenticate with credentials from either IAM Identity Center or Builder ID. Chatting with Amazon Q Developer about code Chat with Amazon Q Developer in your integrated development environment (IDE) to ask questions about building at AWS and for assistance with software development. Amazon Q can explain coding concepts and code snippets, generate code and unit tests, and improve code, including debugging or refactoring. Topics • The agentic coding experience with Amazon Q Developer in VS Code • Chatting with Amazon Q in natural languages • Working with Amazon Q in your IDE • Example topics and questions • Reporting issues with responses from Amazon Q • Explaining and updating code with Amazon Q Developer IAM principals in your AWS console 100 Amazon Q Developer User Guide • Chatting inline with Amazon Q Developer • Adding context to Amazon Q Developer chat in the IDE • Viewing, deleting, and exporting the Amazon Q Developer conversation history The agentic coding experience with Amazon Q Developer in VS Code Agentic coding is on by default for Amazon Q Developer in the IDE. With agentic coding, Amazon Q acts as your coding partner, chatting agentically with you as you develop. As you discuss your project with Amazon Q, it will oﬀer suggestions for shell commands. Sometimes, when it deems those commands to be low-risk, it will run them on its own. When you ask Amazon Q to improve your code, it will do so directly. You can view the changes in a diﬀ and optionally undo them. While Amazon Q is thinking between prompts, you have the option to continue to add instructions in the input window. You can toggle agentic coding on or oﬀ with the </> icon at the bottom of the chat panel. Chatting with Amazon Q in natural languages Amazon Q Developer provides multi-language support when you chat in the IDE. Supported natural languages include Mandarin, French, German, Italian, Japanese, Spanish, Korean, Hindi, and Portuguese, with more languages available. To utilize this functionality, you can start a conversation with Amazon Q in the IDE using your preferred natural language. Amazon Q automatically detects the language and provides responses in the
amazonq-developer-ug-040	amazonq-developer-ug.pdf	40	you have the option to continue to add instructions in the input window. You can toggle agentic coding on or oﬀ with the </> icon at the bottom of the chat panel. Chatting with Amazon Q in natural languages Amazon Q Developer provides multi-language support when you chat in the IDE. Supported natural languages include Mandarin, French, German, Italian, Japanese, Spanish, Korean, Hindi, and Portuguese, with more languages available. To utilize this functionality, you can start a conversation with Amazon Q in the IDE using your preferred natural language. Amazon Q automatically detects the language and provides responses in the appropriate language. Working with Amazon Q in your IDE You can ask Amazon Q questions, update your code, and initiate actions with quick commands all from the Amazon Q chat panel in your IDE. To start chatting with Amazon Q, choose the Amazon Q icon from the navigation bar in your IDE and enter your question in the text bar. To start chatting with Amazon Q in Visual Studio, choose View from the main menu and then choose Amazon Q chat. Agentic coding 101 Amazon Q Developer User Guide When you ask Amazon Q a question, it uses the current ﬁle that is open in your IDE as context, including the programming language and the ﬁle path. If Amazon Q includes code in its response, you can copy the code or insert it directly into your ﬁle by choosing Insert at cursor. Amazon Q might include inline references to its sources in its response. To view a list of sources, expand the Sources section at the bottom of a response. Amazon Q maintains the context of your conversation within a given session inform future responses. You can ask follow up questions or refer to previous questions and responses throughout the duration of your session. To start a new conversation with Amazon Q, open a new tab in the panel. You can open up to 10 tabs at a time. Amazon Q doesn't retain context across diﬀerent conversations. Chat commands You can enter the following commands in the chat panel to access Amazon Q features, depending on your IDE. For information about what Amazon Q features are available in your IDE, see Supported IDEs. • /transform - Use this command to update the code language version of an entire project. For more information, see Upgrading Java versions. • /dev - Use this command to get an implementation plan to develop a feature with Amazon Q. For more information, see Developing features (/dev). • /test - Use this command to generate unit tests for your code with Amazon Q. For more information, see Generating unit tests (/test). • /review - Use this command to review your codebase for security vulnerabilities and code quality issues with Amazon Q. For more information, see Reviewing code (/review). • /doc - Use this command to generate READMEs for your project base with Amazon Q. For more information, see Generating documentation (/doc). • /clear - Use this command to clear a current conversation. This removes all previous conversation from the chat panel and clears the context that Amazon Q has about your previous conversation. • /help - Use this command to see an overview of what Amazon Q can and can't do, example questions, and quick commands. Working with Amazon Q in your IDE 102 Amazon Q Developer User Guide Example topics and questions Within IDEs, Amazon Q can answer questions about AWS services and software development, in addition to generating code. Amazon Q is particularly useful for answering questions related to the following subject areas: • Building on AWS, including AWS service selection, limits, and best practices • General software development concepts, including programming language syntax and application development • Writing code, including explaining code, debugging code, and writing unit tests Following are some example questions that you can ask to get the most out of Amazon Q in your IDE: • How do I debug issues with my Lambda functions locally before deploying to AWS? • How do I choose between AWS Lambda and Amazon EC2 for a scalable web application backend? • What is the syntax of declaring a variable in TypeScript? • How do I write an app in React? • Provide me a description of what this [selected code or application] does and how it works. • Generate test cases for [selected code or function]. Reporting issues with responses from Amazon Q You can optionally leave feedback for every response Amazon Q generates by using the thumbs- up and thumbs-down icons. To report an issue with a response, choose the thumbs-down icon, and enter information in the feedback window that appears. Explaining and updating code with Amazon Q Developer Amazon Q Developer can explain and update speciﬁc lines of code in your
amazonq-developer-ug-041	amazonq-developer-ug.pdf	41	do I write an app in React? • Provide me a description of what this [selected code or application] does and how it works. • Generate test cases for [selected code or function]. Reporting issues with responses from Amazon Q You can optionally leave feedback for every response Amazon Q generates by using the thumbs- up and thumbs-down icons. To report an issue with a response, choose the thumbs-down icon, and enter information in the feedback window that appears. Explaining and updating code with Amazon Q Developer Amazon Q Developer can explain and update speciﬁc lines of code in your integrated development environment (IDE). To update your code, ask Amazon Q to make changes to a given line or block of code, and it will generate new code that reﬂects the changes that you asked it to make. Then, you can insert the updated code directly into the ﬁle where the code originated. You can choose from the following options: Example topics and questions 103 Amazon Q Developer User Guide • Explain – Get your code explained in natural language. • Refactor – Improve code readability or eﬃciency, among other improvements. • Fix – Debug code. • Generate tests – Create unit tests for the current ﬁle or selected code. • Optimize – Enhance code performance. • Send to prompt – Send the highlighted code to the Amazon Q chat panel, and ask questions that you have about the code. Send code to Amazon Q To get your code explained or updated by Amazon Q, complete the following steps. 1. Highlight a section of a code ﬁle in your IDE. 2. Right-click your highlighted code to open a context window. Choose Amazon Q, and then choose Explain, Refactor, Fix, Generate tests, Optimize, or Send to prompt. If you choose Send to prompt, Amazon Q copies the highlighted code to the chat panel, where you can enter questions that you have about the code. 3. To replace the highlighted code with the newly generated code, you can copy the code or insert it directly into your ﬁle by choosing Insert code. Amazon Q replaces the original code with the updated code. Chatting inline with Amazon Q Developer The inline chat feature lets you transform existing code—or generate new code—right from your IDE's main coding window. To use the inline chat feature, you highlight code that you want suggestions for, and provide instructions in the small input screen. Amazon Q proceeds to generate code for you, which it presents in a diﬀ within the main coding window. You can then choose to accept or reject the changes. The advantage of inline chat is that it eliminates the context switching that occurs when moving between a chat window and the main coding window. You would typically use the inline chat feature when you're reviewing code, writing unit tests, or performing other tasks that require code-based answers. For situations where you want text-based Chatting inline 104 Amazon Q Developer User Guide answers (for example, an answer to "Explain this code") then using the chat window is a better option. Amazon Q considers the code in the current ﬁle when generating a code recommendation through the inline chat. It won’t look at code in other ﬁles or projects. Amazon Q inline chat in action An inline chat session unfolds as follows. 1. You highlight the code that you want suggestions for, and then choose from the following options based on your IDE: • In Visual Studio Code and JetBrains, press #+I (Mac) or Ctrl+I (Windows) • In Eclipse, press #+Shift+I (Mac) or Ctrl+Shift+I (Windows) • Alternatively, you can right-click the selection and choose Amazon Q and then Inline chat This launches a small input screen at the top of the main coding window where you can enter a prompt, such as Fix this code. 2. Amazon Q generates code and presents it in a diﬀ. Chatting inline 105 Amazon Q Developer User Guide 3. You accept or reject the change by choosing Accept or Reject, or by pressing the keyboard equivalents (Enter or Esc). Example topics and questions The inline chat always returns code as the answer, so you can enter prompts like: • Document this code • Refactor this code Chatting inline 106 Amazon Q Developer • Write unit tests for this function Diﬀ format User Guide The inline chat displays the diﬀ in multiple blocks, with the existing code on the top, and the suggested code on the bottom. A side-by-side diﬀ is not supported. Adding context to Amazon Q Developer chat in the IDE When you chat with Amazon Q in the integrated development environment (IDE), you can provide Amazon Q with additional context, such as ﬁles, folders, among other types of information. Amazon Q will use this context to tailor and
amazonq-developer-ug-042	amazonq-developer-ug.pdf	42	this code • Refactor this code Chatting inline 106 Amazon Q Developer • Write unit tests for this function Diﬀ format User Guide The inline chat displays the diﬀ in multiple blocks, with the existing code on the top, and the suggested code on the bottom. A side-by-side diﬀ is not supported. Adding context to Amazon Q Developer chat in the IDE When you chat with Amazon Q in the integrated development environment (IDE), you can provide Amazon Q with additional context, such as ﬁles, folders, among other types of information. Amazon Q will use this context to tailor and improve its answers. There are two ways to provide context to Amazon Q: • Explicitly – To provide context explicitly, you enter @ in the chat window. The @ launches a context picker pop-up from which you select items to include as context. Alternatively, you can type @ and begin typing the name of the ﬁle, folder, or other context type to have it auto- complete. For more information, see Explicit context types. • Automatically – To provide context automatically, you set up the context separately, outside of the chat. Amazon Q automatically references the context whenever any developer working on the project types a question into the chat window. For more information, see Automatic context types. After Amazon Q generates an answer, it shows you the ﬁles it used as context in the Context drop- down list, which appears immediately above the start of the answer. Explicit context types When you type @ in the chat, you can select from the following context types: • @workspace – Amazon Q uses your project’s workspace as context for its answers. The @workspace option requires conﬁguration. For more information, see Adding workspace context to Amazon Q Developer chat in the IDE. • Folders – Amazon Q shows you a list of folders in the current project, and uses the folder you select as context for its answers. • Files – Amazon Q shows you a list of ﬁles in the current project, and uses the ﬁle you select as context for its answers. Adding context to the chat 107 Amazon Q Developer User Guide • Code – Amazon Q shows you a list of classes, functions, global variables in the current project, and uses your selection as context for its answers. • Prompts – Amazon Q shows you a list of prompts that you have saved, and uses the prompt you select as context for its answers. The Prompts option requires some conﬁguration. For more information, see Saving prompts to a library for use with Amazon Q Developer chat. Automatic context types The following types of contexts will be used automatically by Amazon Q, if you've set them up: • Project rules – Amazon Q will automatically use a set of project rules that you deﬁne as context. For more information, see Creating project rules for use with Amazon Q Developer chat. • Customizations – Amazon Q will automatically use a repository of source code as context. For more information about setting up customizations, see Customizing suggestions. Adding workspace context to Amazon Q Developer chat in the IDE When you chat with Amazon Q in the integrated development environment (IDE), you can add @workspace to your question to automatically include the most relevant chunks of your workspace code as context. Amazon Q Developer determines relevance based on an index that is updated periodically. With workspace context, Amazon Q has enhanced capabilities, including locating ﬁles, understanding how code is used across ﬁles, and generating code that leverages multiple ﬁles, including ﬁles that aren’t opened. Topics • Setup • Ask questions with workspace context Setup Before you continue, make sure you have the latest version of your IDE installed. You can then complete the following setup steps. Adding context to the chat 108 Amazon Q Developer Enable indexing User Guide To use your workspace as context, Amazon Q creates a local index of your workspace repository, including code ﬁles, conﬁguration ﬁles, and project structure. During indexing, non-essential ﬁles like binaries or those speciﬁed in .gitignore ﬁles are ﬁltered out. It can take 5 to 20 minutes to index a new workspace. During this time, you can expect elevated CPU usage in your IDE. After initial indexing, the index is incrementally updated when you make changes to your workspace. The ﬁrst time you add workspace context, you must enable indexing in your IDE. Complete the following steps to enable indexing: 1. Add @workspace to your question in the Amazon Q chat panel. 2. Amazon Q prompts you to enable indexing. Choose Settings to be redirected to Amazon Q settings in your IDE. If you aren't prompted, you can go to settings by choosing Amazon Q at the bottom of your IDE. Then, choose Open Settings
amazonq-developer-ug-043	amazonq-developer-ug.pdf	43	you can expect elevated CPU usage in your IDE. After initial indexing, the index is incrementally updated when you make changes to your workspace. The ﬁrst time you add workspace context, you must enable indexing in your IDE. Complete the following steps to enable indexing: 1. Add @workspace to your question in the Amazon Q chat panel. 2. Amazon Q prompts you to enable indexing. Choose Settings to be redirected to Amazon Q settings in your IDE. If you aren't prompted, you can go to settings by choosing Amazon Q at the bottom of your IDE. Then, choose Open Settings from the Amazon Q task bar that opens. 3. Select the box next to Workspace Index. Conﬁgure indexing (optional) No conﬁguration is necessary for the indexing process, however you can choose to specify the number of threads dedicated to indexing. If you increase the number of threads used, indexing will complete faster, and it will use more of your CPU. To update the indexing conﬁguration, specify the number of threads for the Workspace Index Worker Threads setting. You can also set the maximum size of the ﬁles that can be indexed for workspace context, and enable the use of your graphics processing unit (GPU) for indexing. Ask questions with workspace context To add your workspace as context to your conversation with Amazon Q, open the workspace you want to ask questions about, and then add @workspace to your question in the chat panel. You must add @workspace to any question that you want to add workspace context to. If you want to start chatting about a diﬀerent workspace, open the workspace, and then open a new chat tab. Include @workspace in your question to add the new workspace as context. Adding context to the chat 109 Amazon Q Developer User Guide You can ask Amazon Q about any ﬁle in your workspace, including unopened ﬁles. Amazon Q can explain ﬁles, locate code, and generate code across ﬁles, in addition to existing conversational coding capabilities. Following are example questions you can ask Amazon Q that leverage workspace context in the chat: • @workspace where is the code that handles authorization? • @workspace what are the key classes with application logic in this project? • @workspace explain main.py • @workspace add auth to this project • @workspace what third-party libraries or packages are used in this project, and for what purpose? • @workspace add unit tests for function <function name> Saving prompts to a library for use with Amazon Q Developer chat You can build a library of common prompts that you can use when chatting with Amazon Q in the IDE. By storing these prompts in your library, you can easily insert them into the chat without having to retype the prompt each time. You can use saved prompts across multiple conversations and projects. Prompts are saved in the ~/.aws/amazonq/prompts folder. To save a prompt to a prompt library 1. 2. In your IDE, open an Amazon Q chat window. Type @, and select Prompts. 3. Choose Create a new prompt. 4. In Prompt name, enter a prompt name such as Create sequence diagram and press Enter. Amazon Q creates a prompt ﬁle called Create sequence diagram.md in the ~/.aws/ amazonq/prompts folder, and opens the ﬁle in your IDE. 5. In the prompt ﬁle, add a detailed prompt. For example: Adding context to the chat 110 Amazon Q Developer User Guide Create a sequence diagram using Mermaid that shows the sequence of calls between resources. Ignore supporting resources like IAM policies and security group rules. 6. Save the prompt ﬁle. To use a saved prompt 1. 2. In your IDE, open an Amazon Q chat window. Type @, and select Prompts. 3. Choose your saved prompt, for example, Create sequence diagram. 4. (Optional) In the chat input window, add details, as required. You can type more text and add more context types. An example prompt might look like this... @Create a sequence diagram using the files in the @lib folder 5. Submit the prompt and wait for Amazon Q to generate an answer. Creating project rules for use with Amazon Q Developer chat You can build a library of project rules that you can use when chatting with Amazon Q in the IDE. These rules describe coding standards and best practices across your team. For example, you could have a rule that states that all Python code must use type hints, or that all Java code must use Javadoc comments. By storing these rules in your project, you can ensure consistency across developers, regardless of their experience level. Project rules are deﬁned in Markdown ﬁles in the project's project-root/.amazonq/rules folder. Once you've created your project rules, Amazon Q will automatically use them as context whenever a developer chats with Amazon Q
amazonq-developer-ug-044	amazonq-developer-ug.pdf	44	that you can use when chatting with Amazon Q in the IDE. These rules describe coding standards and best practices across your team. For example, you could have a rule that states that all Python code must use type hints, or that all Java code must use Javadoc comments. By storing these rules in your project, you can ensure consistency across developers, regardless of their experience level. Project rules are deﬁned in Markdown ﬁles in the project's project-root/.amazonq/rules folder. Once you've created your project rules, Amazon Q will automatically use them as context whenever a developer chats with Amazon Q within your project, and will make sure to adhere to them when generating answers. For more information about adding context to the chat, see Adding context to Amazon Q Developer chat in the IDE. To create a project rule 1. 2. In your IDE, open the project's root folder. In the project root folder, create the following folder: Adding context to the chat 111 Amazon Q Developer User Guide project-root/.amazonq/rules This folder holds all your project rules. 3. In project-root/.amazonq/rules, create a project rule ﬁle. It must be a Markdown ﬁle. For example: cdk-rules.md 4. Open your project rule Markdown ﬁle. 5. Add a detailed prompt to the ﬁle. For example: All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access. All Amazon DynamoDB Streams tables must have encryption enabled. All Amazon SNS topics must have encryption enabled and enforce SSL. All Amazon SNS queues must enforce SSL. 6. 7. Save the ﬁle. (Optional) Add more project rule Markdown ﬁles. You have now created one or more project rules. Amazon Q will use these rules as context automatically whenever a developer chats with Amazon Q within your project. Viewing, deleting, and exporting the Amazon Q Developer conversation history When you chat with Amazon Q in the integrated development environment (IDE), Amazon Q saves each of your chat tabs as a separate conversation. You can view, search for, and delete these conversations. You can also export them to Markdown or HTML format ﬁles. Amazon Q stores your conversations on your local computer, in your home directory. Amazon Q saves conversations for each workspace separately, so if you don't see your conversation history, it might be because you're in the wrong workspace. Amazon Q only displays the conversation history for the current workspace. Use the following instructions to view, search for, delete, and export your conversations. Managing conversations 112 Amazon Q Developer User Guide To view and search for past conversations 1. In your IDE, sign in to Amazon Q. 2. Open an Amazon Q chat tab. 3. Open the chat history by doing one of the following: • On the top-right of the chat panel, choose the View chat history button. • Press ctrl+F (Windows and Linux) or # F (Mac). 4. Do one of the following: • Choose the conversation you want to view. Conversations are organized by date. • Use the search bar near the top of the chat history to ﬁnd a conversation. Amazon Q ﬁnds conversations that match exactly the text you enter. To delete a single conversation 1. In your IDE, sign in to Amazon Q. 2. Do one of the following: • In the chat tab of an open chat session, enter /clear to delete the contents of the chat tab. • Open an Amazon Q chat tab, and then open the chat history by doing one of the following: • On the top-right of the chat panel, choose the View chat history button. • Press ctrl+F (Windows and Linux) or # F (Mac). In the conversation that you want to delete, choose the vertical ellipsis (⋮) and choose Delete. To export a conversation to Markdown or HTML 1. In your IDE, sign in to Amazon Q. 2. Do one of the following: • With a chat session already started, on the top-right of the chat panel, choose the Export button to export the conversation displayed in the tab. • Open an Amazon Q chat tab, and then open the chat history by doing one of the following: • On the top-right of the chat panel, choose the View chat history button. Managing conversations 113 Amazon Q Developer User Guide • Press ctrl+F (Windows and Linux) or # F (Mac). In the conversation that you want to export, choose the vertical ellipsis (⋮) and choose Export to export the conversation to a Markdown or HTML format ﬁle. By default, Amazon Q names the ﬁle q-dev-chat-yyyy-mm-dd.md\|html and saves it in the root of your project. Generating inline suggestions with Amazon Q Developer Amazon Q can provide you with code recommendations in real time. As you write code, Amazon Q automatically generates suggestions based on your existing code and comments. Your personalized recommendations
amazonq-developer-ug-045	amazonq-developer-ug.pdf	45	button. Managing conversations 113 Amazon Q Developer User Guide • Press ctrl+F (Windows and Linux) or # F (Mac). In the conversation that you want to export, choose the vertical ellipsis (⋮) and choose Export to export the conversation to a Markdown or HTML format ﬁle. By default, Amazon Q names the ﬁle q-dev-chat-yyyy-mm-dd.md\|html and saves it in the root of your project. Generating inline suggestions with Amazon Q Developer Amazon Q can provide you with code recommendations in real time. As you write code, Amazon Q automatically generates suggestions based on your existing code and comments. Your personalized recommendations can vary in size and scope, ranging from a single line comment to fully formed functions. When you start typing out single lines of code or comments, Amazon Q makes suggestions based on your current and previous inputs. Filenames are also taken into consideration. Inline suggestions are automatically enabled when you download the Amazon Q extension. To get started, start writing code, and Amazon Q will begin generating code suggestions. You can also customize the suggestions Amazon Q generates to your software development team's internal libraries, proprietary algorithmic techniques, and enterprise code style. For more information on customizing suggestions, see Customizing suggestions. Topics • Pausing suggestions with Amazon Q • Amazon Q code completion in action • Generating inline suggestions in AWS coding environments • Using shortcut keys • Using code references • Code examples Pausing suggestions with Amazon Q Choose your IDE to see steps for pausing and resuming inline code suggestions in Amazon Q. Generating inline suggestions 114 Amazon Q Developer Visual Studio Code User Guide 1. In VS Code, choose Amazon Q from the component tray at the bottom of the IDE window. The Amazon Q task bar opens at the top of the IDE window. 2. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. The following image shows the Amazon Q task bar in VS Code. JetBrains 1. In your JetBrains IDE, choose Amazon Q from the status bar at the bottom of the IDE window. The Amazon Q task bar opens above the status bar. 2. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. The following image shows the Amazon Q task bar in a JetBrains IDE. Pausing suggestions 115 Amazon Q Developer User Guide Eclipse 1. In your Eclipse IDE, choose the Amazon Q icon in the top right corner of the IDE. 2. With the Amazon Q chat tab open, choose the ellipsis icon in the top right corner of the tab. The Amazon Q task bar opens. The following image shows the Amazon Q task bar in an Eclipse IDE. Pausing suggestions 116 Amazon Q Developer User Guide 3. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. Visual Studio 1. 2. From the edge of the window, choose the Amazon Q icon. Select Pause Auto-Suggesions or Resume Auto-Suggestions The following image shows the Amazon Q task bar in a Visual Studio. AWS Cloud9 Amazon Q does not support toggling suggestions on and oﬀ in AWS Cloud9. Pausing suggestions 117 Amazon Q Developer User Guide To stop receiving Amazon Q suggestions in AWS Cloud9, remove the IAM policy that gives Amazon Q access to AWS Cloud9 from the role or user that you are using to access AWS Cloud9. AWS Lambda To deactivate or re-activate Amazon Q code suggestions in Lambda: 1. 2. 3. In the Lambda console, open the screen for a particular Lambda function. In the Code source section, from the toolbar, choose Tools. From the dropdown menu, choose Amazon Q Code Suggestions. Amazon SageMaker AI Studio 1. In the SageMaker AI Studio console, choose Amazon Q from the bottom of the window. The Amazon Q panel will open. 2. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. JupyterLab 1. In the JupyterLab console, choose Amazon Q from the bottom of the window. The Amazon Q panel will open. 2. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. AWS Glue Studio Notebook 1. In the AWS Glue Studio Notebook console, choose Amazon Q from the bottom of the window. The Amazon Q panel will open. 2. Choose Pause Auto-Suggestions or Resume Auto-Suggestions. Amazon Q code completion in action This section demonstrates how Amazon Q can help you write a complete application. This application creates an Amazon S3 bucket and a Amazon DynamoDB table, plus a unit test that validates both tasks. Amazon Q code completion in action 118 Amazon Q Developer User Guide Here, Amazon Q helps the developer choose which libraries to import. Using the arrow keys, the developer toggles through multiple suggestions. Here, the developer enters a comment, describing the code they intend to write on the next line. Amazon Q correctly anticipates the method to be called. The developer can accept the suggestion with the tab key. Here, the developer prepares to deﬁne constants. Amazon Q code completion
amazonq-developer-ug-046	amazonq-developer-ug.pdf	46	This application creates an Amazon S3 bucket and a Amazon DynamoDB table, plus a unit test that validates both tasks. Amazon Q code completion in action 118 Amazon Q Developer User Guide Here, Amazon Q helps the developer choose which libraries to import. Using the arrow keys, the developer toggles through multiple suggestions. Here, the developer enters a comment, describing the code they intend to write on the next line. Amazon Q correctly anticipates the method to be called. The developer can accept the suggestion with the tab key. Here, the developer prepares to deﬁne constants. Amazon Q code completion in action 119 Amazon Q Developer User Guide Amazon Q correctly anticipates that the ﬁrst constant will be REGION and that its value will be us- east-1, which is the default. Here, the developer prepares to write code that will open sessions between the user and both Amazon S3 and DynamoDB. Amazon Q, familiar with AWS APIs and SDKs, suggests the correct format. Amazon Q code completion in action 120 Amazon Q Developer User Guide The developer has merely written the name of the function that will create the bucket. But based on that (and the context), Amazon Q oﬀers a full function, complete with try/except clauses. Notice the use of TEST_BUCKET_NAME, which is a constant declared earlier in the same file. The developer has only just begun to type in the name of the function that will create a DynamoDB table. But Amazon Q can tell where this is going. Notice that the suggestion accounts for the DynamoDB session created earlier, and even mentions it in a comment. Amazon Q code completion in action 121 Amazon Q Developer User Guide The developer has done little more than write the name of the unit test class, when Amazon Q oﬀers to complete it. Notice the built-in references to the two functions created earlier in the same ﬁle. The developer has only just begun to type in the name of the function that will create a DynamoDB table. But Amazon Q can tell where this is going. Notice that the suggestion accounts for the DynamoDB session created earlier, and even mentions it in a comment. Amazon Q code completion in action 122 Amazon Q Developer User Guide Based only on a comment and the context, Amazon Q supplies the entire main function. All that's left is the main guard, and Amazon Q knows it. Based only on a comment and the context, Amazon Q supplies the entire main function. Amazon Q code completion in action 123 Amazon Q Developer User Guide Finally, the developer runs the unit test from the terminal of the same IDE where the coding took place. Amazon Q code completion in action 124 Amazon Q Developer User Guide Generating inline suggestions in AWS coding environments In addition to third-party IDEs, Amazon Q Developer can generate inline suggestions within AWS services that provide their own coding environments. The following sections describe how to set up Amazon Q inline code suggestions within integrated AWS services. Suggestions in AWS coding environments 125 Amazon Q Developer Note User Guide If you are using Amazon Q as part of an enterprise, then you are using Amazon Q Developer Pro. In that case, administrators at your organization must complete additional steps before you can start coding. For more information, see Getting started with Amazon Q Developer. Topics • Using Amazon Q Developer with Amazon SageMaker AI Studio • Using Amazon Q Developer with JupyterLab • Using Amazon Q Developer with Amazon EMR Studio • Using Amazon Q Developer with AWS Glue Studio • Using Amazon Q Developer with AWS Lambda • Using Amazon Q Developer with other services Using Amazon Q Developer with Amazon SageMaker AI Studio You can chat with Amazon Q inside Amazon SageMaker AI Studio. You can also make code recommendations automatically as you write your code. To use Amazon Q Developer with Amazon SageMaker AI Studio, you must add Amazon Q permissions to your SageMaker AI execution role. The way you conﬁgure permissions depends on whether you are using the Amazon Q Developer Free tier or the Pro tier. To set up and activate Amazon Q for Amazon SageMaker AI Studio, see Set up Amazon Q Developer for your users in the Amazon SageMaker AI User Guide. Using Amazon Q Developer with JupyterLab This page describes how to set up and activate Amazon Q Developer for JupyterLab. Once activated, Amazon Q can make code recommendations automatically as you write your code. Note Python is the only programming language that Amazon Q supports in JupyterLab. Suggestions in AWS coding environments 126 Amazon Q Developer Installing JupyterLab User Guide Install JupyterLab on your computer or if you already have JupyterLab installed, check its version by running the following command. pip show
amazonq-developer-ug-047	amazonq-developer-ug.pdf	47	AI Studio, see Set up Amazon Q Developer for your users in the Amazon SageMaker AI User Guide. Using Amazon Q Developer with JupyterLab This page describes how to set up and activate Amazon Q Developer for JupyterLab. Once activated, Amazon Q can make code recommendations automatically as you write your code. Note Python is the only programming language that Amazon Q supports in JupyterLab. Suggestions in AWS coding environments 126 Amazon Q Developer Installing JupyterLab User Guide Install JupyterLab on your computer or if you already have JupyterLab installed, check its version by running the following command. pip show jupyterlab Note the version in the response, and follow the use the corresponding directions in one of the following sections. Installation using pip for Jupyter Lab version >= 4.0 You can install and enable the Amazon Q extension for JupyterLab 4 with the following commands. # JupyterLab 4 pip install amazon-q-developer-jupyterlab-ext Installation using pip for Jupyter Lab version >= 3.6 and < 4.0 You can install and enable the Amazon Q extension for JupyterLab 3 with the following commands. # JupyterLab 3 pip install amazon-q-developer-jupyterlab-ext~=3.0 jupyter server extension enable amazon-q-developer-jupyterlab-ext Authenticating with AWS Builder ID In the following procedure, you will set up Builder ID, which you will use to authenticate when you enable Amazon Q. 1. Refresh the browser tab on which you are using JupyterLab. 2. 3. From the Amazon Q panel at the bottom of the window, choose Start Amazon Q. From the pop-up window, choose Copy Code and Proceed. 4. On the Create AWS Builder ID page, if you don't have a Builder ID, enter a personal email address and choose Next. If you already have a Builder ID, skip to the step about the Authorize request page. Suggestions in AWS coding environments 127 Amazon Q Developer User Guide 5. On the next Create your AWS Builder ID page, enter a name and choose Next. 6. After you receive your email veriﬁcation code, enter it in the blank ﬁeld and choose Verify. 7. On the next screen, choose and conﬁrm a password, then choose Create AWS Builder ID 8. On the next page choose Allow to allow Amazon Q to access your data. Now you should be logged into Amazon Q in JupyterLab with Builder ID. To begin coding, see Using shortcut keys. Using Amazon Q Developer with Amazon EMR Studio This page describes how to set up and activate Amazon Q Developer for Amazon EMR Studio. Once activated, Amazon Q can make code recommendations automatically as you write your ETL code. Note Amazon Q supports Python, which can be used to code ETL scripts for Spark jobs in Amazon EMR Studio. Use the following procedure to set up Amazon EMR Studio to work with Amazon Q. 1. Set up Amazon EMR Studio Notebook. 2. Attach the following policy to the IAM user role for Amazon EMR Studio Notebook. Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. Suggestions in AWS coding environments 128 Amazon Q Developer User Guide { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonQDeveloperPermissions", "Effect": "Allow", "Action": [ "codewhisperer:GenerateRecommendations" ], "Resource": "" } ] } 3. Open the Amazon EMR console. 4. Under Amazon EMR Studio, choose Workspaces (Notebooks). 5. Select your desired Workspace and choose Quick launch. Using Amazon Q Developer with AWS Glue Studio This page describes how to set up and activate Amazon Q Developer for AWS Glue Studio Notebook. Once activated, Amazon Q can make code recommendations automatically as you write your ETL code. Note Amazon Q supports both Python and Scala, the two languages used for coding ETL scripts for Spark jobs in AWS Glue Studio. In the following procedure, you will set up AWS Glue to work with Amazon Q. 1. Set up AWS Glue Studio Notebook. 2. Attach the following policy to your IAM role for Glue Studio notebook Suggestions in AWS coding environments 129 Amazon Q Developer Note User Guide The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonQDeveloperPermissions", "Effect": "Allow", "Action": [ "codewhisperer:GenerateRecommendations" ], "Resource": "" } ] } 3. Open the Glue console 4. Under ETL jobs, choose Notebooks. 5. Verify that Jupyter Notebook is selected. Choose Create. 6. 7. Enter a Job name. For IAM role, select the role that you conﬁgured to interact with Amazon Q 8. Choose Start notebook. Using Amazon Q Developer with AWS Lambda This document describes how to set up and activate Amazon Q Developer for the Lambda console. Once activated, Amazon Q can make code recommendations on demand in
amazonq-developer-ug-048	amazonq-developer-ug.pdf	48	Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonQDeveloperPermissions", "Effect": "Allow", "Action": [ "codewhisperer:GenerateRecommendations" ], "Resource": "" } ] } 3. Open the Glue console 4. Under ETL jobs, choose Notebooks. 5. Verify that Jupyter Notebook is selected. Choose Create. 6. 7. Enter a Job name. For IAM role, select the role that you conﬁgured to interact with Amazon Q 8. Choose Start notebook. Using Amazon Q Developer with AWS Lambda This document describes how to set up and activate Amazon Q Developer for the Lambda console. Once activated, Amazon Q can make code recommendations on demand in the Lambda code editor as you develop your function. Suggestions in AWS coding environments 130 Amazon Q Developer Note User Guide In the Lambda console, Amazon Q only supports functions using the Python and Node.js runtimes. AWS Identity and Access Management permissions for Lambda For Amazon Q to provide recommendations in the Lambda console, you must enable the correct IAM permissions for either your IAM user or role. You must add the codewhisperer:GenerateRecommendations permission, as outlined in the sample IAM policy below: Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonQDeveloperPermissions", "Effect": "Allow", "Action": ["codewhisperer:GenerateRecommendations"], "Resource": "" } ] } It is best practice to use IAM policies to grant restrictive permissions to IAM principals. For details about working with IAM for AWS Lambda, see Identity and access management in AWS Lambda in the AWS Lambda Developer Guide. Activating Amazon Q Developer with Lambda To activate Amazon Q in the Lambda console code editor, complete these steps. Suggestions in AWS coding environments 131 Amazon Q Developer User Guide 1. Open the Functions page of the Lambda console, and choose the function that you want to edit. 2. As you type in the code editor, automatic code suggestions from Amazon Q are enabled by default. To pause suggestions, choose Amazon Q in the bottom left corner of the Code source panel. The command palette opens at the top of the Code source panel. From there, choose Pause auto-suggestions. For shortcut keys, see Using shortcut keys. Using Amazon Q Developer with other services AWS Identity and Access Management permissions for other services For Amazon Q to provide recommendations in the context of another service, you must enable the correct IAM permissions for either your IAM user or role. You must add the codewhisperer:GenerateRecommendations permission, as outlined in the sample IAM policy below: Note The codewhisperer preﬁx is a legacy name from a service that merged with Amazon Q Developer. For more information, see Amazon Q Developer rename - Summary of changes. { "Version": "2012-10-17", "Statement": [ { "Sid": "AmazonQDeveloperPermissions", "Effect": "Allow", "Action": ["codewhisperer:GenerateRecommendations"], "Resource": "*" } ] } It is best practice to use IAM policies to grant restrictive permissions to IAM principals. For details about working with IAM, see Security best practices in the IAM user guide. Suggestions in AWS coding environments 132 Amazon Q Developer Using shortcut keys User Guide While getting inline suggestions from Amazon Q, you can use keyboard shortcuts for common actions you take, such as initiating Amazon Q or accepting a recommendation. Choose the integrated development environment (IDE) where you are developing code to see keyboard shortcuts for your IDE. Visual Studio Code Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation Previous recommendation Reject a recommendation Right arrow Left arrow ESC, backspace, or keep typing and the recommendation will disappear as soon as there is a character mismatch. Accept next word Option + right arrow To change keybindings in VS Code, see Key Bindings for Visual Studio Code on the VS Code website. Note The inline suggestions toolbar in VS Code is disabled by default. For more information, see Redesigned inline suggestions toolbar on the VS Code website. Using shortcut keys 133 Amazon Q Developer JetBrains User Guide Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation Previous recommendation Reject a recommendation Right arrow Left arrow ESC, backspace, or keep typing and the recommendation will disappear as soon as there is a character mismatch. To change keybindings in IntelliJ, see IntelliJ IDEA keyboard shortcuts on the JetBrains website. Eclipse Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation MacOS: Option + ] Windows: Alt + ] Previous recommendation MacOS: Option + [ Windows: Alt + [ Using shortcut keys 134 Amazon Q Developer Action Reject a recommendation User Guide Keyboard shortcut ESC, backspace, or keep typing and the recommendation will disappear
amazonq-developer-ug-049	amazonq-developer-ug.pdf	49	arrow Left arrow ESC, backspace, or keep typing and the recommendation will disappear as soon as there is a character mismatch. To change keybindings in IntelliJ, see IntelliJ IDEA keyboard shortcuts on the JetBrains website. Eclipse Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation MacOS: Option + ] Windows: Alt + ] Previous recommendation MacOS: Option + [ Windows: Alt + [ Using shortcut keys 134 Amazon Q Developer Action Reject a recommendation User Guide Keyboard shortcut ESC, backspace, or keep typing and the recommendation will disappear as soon as there is a character mismatch. To change keybindings in Eclipse, see Changing the key bindings in the Eclipse documentation. Toolkit for Visual Studio Action Keyboard shortcut Manually initiate Amazon Q Windows: Alt + C AWSToolkit.CodeWhisperer.Ge tSuggestion in the keybindings Accept a recommendation Tab Next recommendation Windows: Alt + . Edit.NextSuggestion in the keybindin gs Previous recommendation Windows: Alt + , Edit.PreviousSuggestion keybindings in the Reject a recommendation ESC, backspace, or keep typing and the recommendation will disappear as soon as there is a character mismatch. See also Microsoft's Visual Studio default keyboard shortcuts. To change keybindings in Visual Studio, use Tools -> Options -> Keyboard. Using shortcut keys 135 Amazon Q Developer Amazon SageMaker AI User Guide Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation Down arrow Previous recommendation Reject a recommendation Up arrow ESC JupyterLab Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Accept a recommendation Tab Next recommendation Down arrow Previous recommendation Reject a recommendation Up arrow ESC AWS Glue Studio Notebook Action Keyboard shortcut Manually initiate Amazon Q MacOS: Option + C Windows: Alt + C Using shortcut keys 136 Amazon Q Developer Action Keyboard shortcut User Guide Accept a recommendation Tab Next recommendation Down arrow Previous recommendation Reject a recommendation Up arrow ESC AWS Lambda Action Keyboard shortcut Manually fetch a code suggestion MacOS: Option + C Windows: Alt + C Accept a suggestion Tab Reject a suggestion ESC, Backspace, scroll in any direction, or keep typing and the recommendation automatically disappears. To change the key bindings, use the following procedure. 1. While viewing a particular function, choose the gear icon to open the Preferences tab. 2. On the Preferences tab, select Keybindings. 3. In the keybindings search box, enter Amazon Q. Using shortcut keys 137 Amazon Q Developer User Guide AWS Cloud9 Action Keyboard shortcut Manually fetch a code suggestion MacOS: Option + C Windows: Alt + C Accept a suggestion Tab Reject a suggestion ESC, Backspace, scroll in any direction, or keep typing and the recommendation automatically disappears. 1. While viewing a particular environment, choose the gear icon to open the Preferences tab. 2. On the Preferences tab, select Keybindings. 3. 4. In the keybindings search box, enter Amazon Q. In the Keystroke column, double-click the space corresponding to the function you're interested in. 5. Enter the keys that you want to bind the function to. Using shortcut keys 138 Amazon Q Developer User Guide Using code references Amazon Q learns, in part, from open-source projects. Sometimes, a suggestion it's giving you may be similar to a speciﬁc piece of training data. Code references include information about the source Amazon Q used to generate a recommendation. Topics • View and update code references • Turn code references oﬀ and on • Opt out of code with references View and update code references With the reference log, you can view references to code recommendations that are similar to training data. You can also update and edit code recommendations suggested by Amazon Q. Choose your IDE to see steps for how to view and update code references. Visual Studio Code To display the Amazon Q reference log in VS Code, use the following procedure. 1. Make sure you are using the latest version of both VS Code and the Amazon Q extension. 2. In VS Code, choose Amazon Q from the component tray at the bottom of the IDE window. Using code references 139 Amazon Q Developer User Guide The Amazon Q task bar opens at the top of the IDE window. 3. Choose Open Code Reference Log. The code reference log tab opens. Any references to code recommendations are listed. The following image shows the open Amazon Q task bar and code reference log tab. JetBrains To display the Amazon Q reference log in JetBrains IDEs, use the following procedure. 1. Make sure you are using the latest version of both your JetBrains IDE and the Amazon Q plugin. 2. In JetBrains, choose Amazon Q from the status bar at the bottom of the IDE window. The Amazon Q task bar opens
amazonq-developer-ug-050	amazonq-developer-ug.pdf	50	bar opens at the top of the IDE window. 3. Choose Open Code Reference Log. The code reference log tab opens. Any references to code recommendations are listed. The following image shows the open Amazon Q task bar and code reference log tab. JetBrains To display the Amazon Q reference log in JetBrains IDEs, use the following procedure. 1. Make sure you are using the latest version of both your JetBrains IDE and the Amazon Q plugin. 2. In JetBrains, choose Amazon Q from the status bar at the bottom of the IDE window. The Amazon Q task bar opens above the status bar. 3. Choose Open Code Reference Log. The code reference log tab opens. Any references to code recommendations are listed. Using code references 140 Amazon Q Developer User Guide The following image shows the open Amazon Q task bar and code reference log tab. Eclipse To display the Amazon Q reference log in Eclipse IDEs, use the following procedure. 1. Make sure you are using the latest version of both the Eclipse IDE and the Amazon Q plugin. 2. In your Eclipse IDE, choose the Amazon Q icon in the top right corner of the IDE. 3. With the Amazon Q chat tab open, choose the ellipsis icon in the top right corner of the tab. The Amazon Q task bar opens. The following image shows the Amazon Q task bar in an Eclipse IDE. Using code references 141 Amazon Q Developer User Guide 4. Choose Open Code Reference Log. The code reference log tab opens. Any references to code recommendations are listed. Toolkit for Visual Studio When Amazon Q suggests code that contains a reference in the Toolkit for Visual Studio, the reference type appears in the suggestion description. All accepted suggestions that contain references are captured in the reference log. To access the reference log, choose the AWS icon, then select Open Code Reference Log. A list of accepted suggestions that contain references will appear. This list includes: • The location where the suggestion was accepted. Double clicking on this will take you to that location in your code. • The associated license • The referenced source code Using code references 142 Amazon Q Developer User Guide • The fragment of code attributed to the reference AWS Cloud 9 When you use Amazon Q with AWS Cloud 9, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. On the AWS Cloud 9 console, in the upper left corner, choose the AWS Cloud 9 logo. 2. From the dropdown menu, choose Preferences. On the right side of the console, the Preferences tab will open. 3. On the Preferences tab, under Project Settings, under Extensions, select AWS Toolkit. 4. Select or deselect Amazon Q: Include Suggestions With Code References. Lambda Amazon Q in Lambda does not support code references. When you use Amazon Q with Lambda, any code suggestions with references are omitted. Using code references 143 Amazon Q Developer SageMaker AI Studio User Guide To display the Amazon Q reference log in SageMaker AI Studio, use the following procedure. 1. At the bottom of the SageMaker AI Studio window, open the Amazon Q panel. 2. Choose Open Code Reference Log. JupyterLab To display the Amazon Q reference log in JupyterLab, use the following procedure. 1. At the bottom of the JupyterLab window, open the Amazon Q panel. 2. Choose Open Code Reference Log. AWS Glue Studio Notebook To display the Amazon Q reference log in AWS Glue Studio Notebook, use the following procedure. 1. At the bottom of the AWS Glue Studio Notebook window, open the Amazon Q panel. 2. Choose Open Code Reference Log. Turn code references oﬀ and on In most IDEs, code references are on by default. Choose your IDE to see steps for how to turn code references oﬀ or on. Visual Studio Code When you use Amazon Q with VS Code, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. Make sure you are using the latest version of both VS Code and the Amazon Q extension. 2. In VS Code, choose Amazon Q from the component tray at the bottom of the IDE window. The Amazon Q task bar opens at the top of the IDE window. 3. Choose Open Settings. The settings tab opens with the options related to Amazon Q displayed. Using code references 144 Amazon Q Developer User Guide 4. Select or deselect the box next to Show Code With References. JetBrains When you use Amazon Q with your JetBrains IDE, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following
amazonq-developer-ug-051	amazonq-developer-ug.pdf	51	Q extension. 2. In VS Code, choose Amazon Q from the component tray at the bottom of the IDE window. The Amazon Q task bar opens at the top of the IDE window. 3. Choose Open Settings. The settings tab opens with the options related to Amazon Q displayed. Using code references 144 Amazon Q Developer User Guide 4. Select or deselect the box next to Show Code With References. JetBrains When you use Amazon Q with your JetBrains IDE, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. Make sure you are using the latest version of both your JetBrains IDE and the Amazon Q plugin. 2. In JetBrains, choose Amazon Q from the status bar at the bottom of the IDE window. The Amazon Q task bar opens above the status bar. 3. Choose Open Settings. The settings window opens with the options related to Amazon Q displayed. 4. Select or deselect the box next to Show Code With References. Eclipse When you use Amazon Q with Eclipse, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. Make sure you are using the latest version of both the Eclipse IDE and the Amazon Q plugin. 2. Open Settings in your Eclipse IDE. 3. Choose Amazon Q from the left navigation bar. 4. Select or deselect the box next to Show Code With References. 5. Choose Apply to save your changes. Toolkit for Visual Studio When you use Amazon Q in the Toolkit for Visual Studio, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. Make sure you are using the latest version of the Toolkit for Visual Studio. 2. Open Options in Visual Studio. Using code references 145 Amazon Q Developer User Guide 3. Choose AWS Toolkit from the left navigation bar, and then choose Amazon Q. 4. From the dropdown next to Include Suggestions With References, select True or False. 5. Choose OK to save your changes. AWS Cloud 9 When you use Amazon Q with AWS Cloud 9, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. On the AWS Cloud 9 console, in the upper left corner, choose the AWS Cloud 9 logo. 2. From the dropdown menu, choose Preferences. On the right side of the console, the Preferences tab will open. 3. On the Preferences tab, under Project Settings, under Extensions, select AWS Toolkit. 4. Select or deselect Amazon Q: Include Suggestions With Code References. Lambda Amazon Q in Lambda does not support code references. When you use Amazon Q with Lambda, any code suggestions with references are omitted. SageMaker AI Studio When you use Amazon Q with SageMaker AI Studio, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. 1. 2. 3. From the top of the SageMaker AI Studio window choose Settings. From the Settings dropdown, choose Advanced Settings Editor. In the Amazon Q dropdown, select or deselect the box next to Enable suggestions with code references. JupyterLab When you use Amazon Q with JupyterLab, code references are on by default. To turn them oﬀ, or to turn them back on later, use the following procedure. Using code references 146 Amazon Q Developer User Guide 1. 2. 3. From the top of the JupyterLab window choose Settings. From the Settings dropdown, choose Advanced Settings Editor. In the Amazon Q dropdown, select or deselect the box next to Enable suggestions with code references. AWS Glue Studio Notebook 1. 2. From the bottom of the AWS Glue Studio Notebook window choose Amazon Q. From the pop-up menu, toggle the switch next to Code with references. Note Pausing code references will be valid only for the duration of the current AWS Glue Studio Notebook. Opt out of code with references In some IDEs, you can opt out of receiving suggestions with references at the administrator level. Choose your IDE to see steps for opting out as an administrator. Visual Studio Code If you are an enterprise administrator, you can opt out of suggestions with code references for your entire organization. If you do this, individual developers in your organization will not be able to opt back in through the IDE. Those developers will be able to select and deselect the box discussed in the previous section, but it will have no eﬀect if you have opted out at the enterprise level. To opt out of suggestions with references at the enterprise level, use the following procedure. 1. 2. In the Amazon
amazonq-developer-ug-052	amazonq-developer-ug.pdf	52	steps for opting out as an administrator. Visual Studio Code If you are an enterprise administrator, you can opt out of suggestions with code references for your entire organization. If you do this, individual developers in your organization will not be able to opt back in through the IDE. Those developers will be able to select and deselect the box discussed in the previous section, but it will have no eﬀect if you have opted out at the enterprise level. To opt out of suggestions with references at the enterprise level, use the following procedure. 1. 2. In the Amazon Q Developer console, choose Settings. In the Amazon Q Developer account details pane, choose Edit. 3. On the Edit details page, in the Advanced settings pane, deselect Include suggestions with code references. 4. Choose Save changes. Using code references 147 Amazon Q Developer JetBrains User Guide If you are an enterprise administrator, you can opt out of suggestions with code references for your entire organization. If you do this, individual developers in your organization will not be able to opt back in through the IDE. Those developers will be able to select and deselect the box discussed in the previous section, but it will have no eﬀect if you have opted out at the enterprise level. To opt out of suggestions with references at the enterprise level, use the following procedure. 1. 2. In the Amazon Q Developer console, choose Settings. In the Amazon Q Developer account details pane, choose Edit. 3. On the Edit details page, in the Advanced settings pane, deselect Include suggestions with code references. 4. Choose Save changes. Eclipse If you are an enterprise administrator, you can opt out of suggestions with code references for your entire organization. If you do this, individual developers in your organization will not be able to opt back in through the IDE. Those developers will be able to select and deselect the box discussed in the previous section, but it will have no eﬀect if you have opted out at the enterprise level. To opt out of suggestions with references at the enterprise level, use the following procedure. 1. 2. In the Amazon Q Developer console, choose Settings. In the Amazon Q Developer account details pane, choose Edit. 3. On the Edit details page, in the Advanced settings pane, deselect Include suggestions with code references. 4. Choose Save changes. Toolkit for Visual Studio To opt out of suggestions with references at the enterprise level, use the following procedure. 1. You can get to the code references setting in one of two ways: Using code references 148 Amazon Q Developer User Guide a. Choose the Amazon Q icon at the edge of the window, and then choose Options... b. Go to Tools -> AWS Toolkit -> Amazon Q 2. Change the toggle to True or False, depending on whether you want to include suggestions with references. AWS Cloud 9 Amazon Q in AWS Cloud 9 does not support opting out of code suggestions with references at the enterprise level. To opt out at the individual developer level, see Toggling code references. Lambda Amazon Q in Lambda does not support code references. When you use Amazon Q with Lambda, any code suggestions with references are omitted. SageMaker AI Studio Amazon Q does not support opting out of code suggestions with references at the enterprise level in SageMaker AI Studio. JupyterLab Amazon Q does not support opting out of code suggestions with references at the enterprise level in JupyterLab. AWS Glue Studio Notebook Amazon Q does not support opting out of code suggestions with references in AWS Glue Studio Notebook. Code examples Amazon Q can suggest code in diﬀerent scenarios. To understand how it can help you as you write code in your programming language of choice, view the following code examples. Topics • Using Amazon Q Developer for single-line code completion • Using Amazon Q Developer for full function generation • Using Amazon Q Developer for block completion Code examples 149 Amazon Q Developer User Guide • Using Amazon Q Developer for Docstring, JSDoc, and Javadoc completion • Using Amazon Q Developer for line-by-line recommendations Using Amazon Q Developer for single-line code completion When you start typing out single lines of code, Amazon Q makes suggestions based on your current and previous inputs. C++ JavaScript In this example, Amazon Q completes a line of code that the developer begins. TypeScript In this example, the user enters a full comment, and then Amazon Q supplies the code that goes with it. Code examples 150 Amazon Q Developer User Guide C# In this example, Amazon Q provides a single-line recommendation based on a comment. Shell In the image below, Amazon Q oﬀers recommendations on how to complete a single line of code. Code examples
amazonq-developer-ug-053	amazonq-developer-ug.pdf	53	completion When you start typing out single lines of code, Amazon Q makes suggestions based on your current and previous inputs. C++ JavaScript In this example, Amazon Q completes a line of code that the developer begins. TypeScript In this example, the user enters a full comment, and then Amazon Q supplies the code that goes with it. Code examples 150 Amazon Q Developer User Guide C# In this example, Amazon Q provides a single-line recommendation based on a comment. Shell In the image below, Amazon Q oﬀers recommendations on how to complete a single line of code. Code examples 151 Amazon Q Developer User Guide Java When you start typing out single lines of code, Amazon Q makes suggestions based on your current and previous inputs. In the example below, in Java, a user enters the string public into an existing class. Based on the input, Amazon Q generates a suggestion for the signature of the main method. Python In this example, Amazon Q recommends a single line of code, based on the developer's comment. Code examples 152 Amazon Q Developer User Guide Using Amazon Q Developer for full function generation Amazon Q can generate an entire function based on a comment that you've written. As you ﬁnish your comment Amazon Q will suggest a function signature. If you accept the suggestion, Amazon Q automatically advances your cursor to the next part of the function and makes a suggestion. Even if you enter an additional comment or line of code in between suggestions, Amazon Q will refactor based on your input. C Code examples 153 Amazon Q Developer C++ User Guide JavaScript In the following example, the user generates, and then edits, a full function based on a set of comments. In the following image, a user has written a function signature for reading a ﬁle from Amazon S3. Amazon Q then suggests a full implementation of the read_from_s3 method. Code examples 154 Amazon Q Developer Note User Guide Sometimes, as in the previous example, Amazon Q includes import statements as part of its suggestions. As a best practice, manually move these import statements to the top of your ﬁle. As another example, in the following image, a user has written a function signature. Amazon Q then suggests a full implementation of the quicksort method. Amazon Q considers past code snippets when making suggestions. In the following image, the user in the previous example has accepted the suggested implementation for quicksort above. The user then writes another function signature for a generic sort method. Amazon Q then suggests an implementation based on what has already been written. Code examples 155 Amazon Q Developer User Guide In the following image, a user has written a comment. Based on this comment, Amazon Q then suggests a function signature. In the following image, the user in the previous example has accepted the suggested function signature. Amazon Q can then suggest a complete implementation of the binary_search function. Java The following list contains examples of how Amazon Q makes suggestions and advances you through the entire process of creating a function. 1. In the following example, a user inputs a comment. Amazon Q suggests a function signature. After the user accepts that suggestion, Amazon Q suggests a function body. Code examples 156 Amazon Q Developer User Guide 2. In the image below, a user inputs a comment in the body of the function prior to accepting a suggestion from Amazon Q. On the following line, Amazon Q generates a suggestion based on the comment. Code examples 157 Amazon Q Developer C# User Guide In the following example, Amazon Q recommends a full function. TypeScript In the following example, Amazon Q generates a function based on the user's docstrings. Python Amazon Q can generate an entire function based on a comment that you've written. As you ﬁnish your comment, Amazon Q will suggest a function signature. If you accept the suggestion, Amazon Q automatically advances your cursor to the next part of the function and makes a suggestion. Even if you enter an additional comment or line of code in between suggestions, Amazon Q will refactor based on your input. In the following example, Amazon Q generates both a full function and the corresponding unit test. Code examples 158 Amazon Q Developer User Guide The following list contains examples of how Amazon Q makes suggestions and advances you through the entire process of creating a function. 1. In the image below, a user has input a comment. The function signature, located below the comment, is a suggestion from Amazon Q. 2. In the image below, the user has accepted the Amazon Q suggestion for a function signature. Accepting the suggestion automatically advanced the cursor and Amazon Q has made a new suggestion for the
amazonq-developer-ug-054	amazonq-developer-ug.pdf	54	Amazon Q generates both a full function and the corresponding unit test. Code examples 158 Amazon Q Developer User Guide The following list contains examples of how Amazon Q makes suggestions and advances you through the entire process of creating a function. 1. In the image below, a user has input a comment. The function signature, located below the comment, is a suggestion from Amazon Q. 2. In the image below, the user has accepted the Amazon Q suggestion for a function signature. Accepting the suggestion automatically advanced the cursor and Amazon Q has made a new suggestion for the function body. Code examples 159 Amazon Q Developer User Guide 3. In the image below, a user input a comment in the body of the function prior to accepting a suggestion from Amazon Q. On the following line, Amazon Q has generated a new suggestion based on the content of the comment. In this example, Amazon Q recommends a full function after the user types part of the signature. Code examples 160 Amazon Q Developer User Guide Using Amazon Q Developer for block completion Block completion is used to complete your if/for/while/try code blocks. C Code examples 161 Amazon Q Developer C++ User Guide Java In the example below, a user enters the signature of an if statement. The body of the statement is a suggestion from Amazon Q. C# In the image below, Amazon Q recommends a way to complete the function. Code examples 162 Amazon Q Developer User Guide TypeScript In the image below, Amazon Q recommends a way to complete the function. Python In this example, Amazon Q recommends a block of code, based on the context. Code examples 163 Amazon Q Developer User Guide Using Amazon Q Developer for Docstring, JSDoc, and Javadoc completion Amazon Q can help you generate or complete documentation inside your code. C++ Javascript In this example, Amazon Q ﬁlls in JSDoc parameters based on existing constants. C# In this example, Amazon Q ﬁlls in JSDoc parameters based on existing constants. Code examples 164 Amazon Q Developer User Guide Java The following example is adapted from an example on the Oracle website. In the image below, the user has entered a docstring. Amazon Q has suggested a function to complete the docstring. The following example is adapted from an example on the Oracle website. In the example below, in Java, the user enters a docstring. Amazon Q suggests a function to process the docstring. Code examples 165 Amazon Q Developer User Guide Python In this example, Amazon Q recommends a Docstring, based on the surrounding context. Code examples 166 Amazon Q Developer User Guide Using Amazon Q Developer for line-by-line recommendations Depending on your use case, Amazon Q may not be able to generate an entire function block in one recommendation. However, Amazon Q can still provide line-by-line recommendations. Go and GoLand In this example, Amazon Q provides line-by-line recommendations. Here is another example of line-by-line recommendations, this time with a unit test. C++ and CLion In this example, Amazon Q provides line-by-line recommendations. Code examples 167 Amazon Q Developer User Guide Python In the following image, the customer has written an initial comment indicating that they want to publish a message to an Amazon CloudWatch Logs group. Given this context, Amazon Q is only able to suggest the client initialization code in its ﬁrst recommendation, as shown in the following image. However, if the user continues to request line-by-line recommendations, Amazon Q also continues to suggest lines of code based on what's already been written. Note In the example above, VPCFlowLogs may not be the correct constant value. As Amazon Q makes suggestions, remember to rename any constants as required. Amazon Q can eventually complete the entire code block as shown in the following image. Code examples 168 Amazon Q Developer User Guide In this example, Amazon Q provides recommendations, one line at at time. Transforming code in the IDE with Amazon Q Developer Amazon Q Developer can transform your code in integrated development environments (IDEs) by performing automated language and operating system (OS)-level upgrades and conversions. You provide the code to be transformed, and Amazon Q generates changes that you can review and apply to your ﬁles. To get started, install Amazon Q in an IDE that supports transformations. Then, see the topic for the type of transformation you'd like to perform with Amazon Q. For more information on IDEs that support transformation and how to install Amazon Q, see Using Amazon Q Developer in the IDE. Topics • Transforming Java applications with Amazon Q Developer Transforming code (/transform) 169 Amazon Q Developer User Guide • Transforming .NET applications with Amazon Q Developer Transforming Java applications with Amazon Q Developer Amazon Q supports the following types of transformations for Java
amazonq-developer-ug-055	amazonq-developer-ug.pdf	55	can review and apply to your ﬁles. To get started, install Amazon Q in an IDE that supports transformations. Then, see the topic for the type of transformation you'd like to perform with Amazon Q. For more information on IDEs that support transformation and how to install Amazon Q, see Using Amazon Q Developer in the IDE. Topics • Transforming Java applications with Amazon Q Developer Transforming code (/transform) 169 Amazon Q Developer User Guide • Transforming .NET applications with Amazon Q Developer Transforming Java applications with Amazon Q Developer Amazon Q supports the following types of transformations for Java applications: • Java language and dependency version upgrades • Embedded SQL conversion for Oracle to PostgreSQL database migration To get started, see the topic for the type of transformation you'd like to perform. Topics • Quotas • Upgrading Java versions with Amazon Q Developer • Converting embedded SQL in Java applications with Amazon Q Developer • Transforming code on the command line with Amazon Q Developer • Troubleshooting issues with Java transformations Quotas Java application transformations with Amazon Q in the IDE and command line maintain the following quotas: • Lines of code per job – The maximum number of code lines that Amazon Q can transform in a given transformation job. • Lines of code per month – The maximum number of code lines that Amazon Q can transform in a month. • Concurrent jobs – The maximum number of transformation jobs you can run at the same time. This quota applies to all transformations in the IDE, including .NET transformations in Visual Studio. • Jobs per month – The maximum number of transformation jobs you can run in one month. Transforming Java applications 170 Amazon Q Developer User Guide Resource Quotas Lines of code per job Free tier: 1000 lines of code Lines of code per month Free tier: 2000 lines of code Concurrent jobs 1 job per user 25 jobs per AWS account Jobs per month Pro tier: 1000 jobs Free tier: 100 jobs Upgrading Java versions with Amazon Q Developer Amazon Q Developer can upgrade your Java applications to newer language versions in the integrated development environment (IDE). Changes Amazon Q can make to upgrade your code include updating deprecated code components and APIs as well as upgrading libraries, frameworks, and other dependencies in your code. To transform your code, Amazon Q ﬁrst builds your code in the source language version and veriﬁes that it has the information necessary to perform the transformation. After Amazon Q successfully transforms your code, you verify and accept the changes in your IDE. For more information about how Amazon Q transforms your code, see How Amazon Q Developer transforms code for Java language upgrades. Topics • Supported Java upgrades and IDEs • Step 1: Prerequisites • Step 2: Conﬁgure your project • Step 3: Transform your code • How Amazon Q Developer transforms code for Java language upgrades Transforming Java applications 171 Amazon Q Developer User Guide Supported Java upgrades and IDEs Amazon Q currently supports the following Java source code versions and target versions for transformations. Transforming code to the same Java version includes upgrading libraries and other dependencies in the source code version. Supported Java upgrades Source code version Supported target versions Java 8 Java 11 Java 17 Java 21 Java 17 and Java 21 Java 17 and Java 21 Java 17 and Java 21 Java 21 Amazon Q supports Java upgrades in the following IDEs: • Modules in JetBrains IDEs • Projects and workspaces in Visual Studio Code Step 1: Prerequisites Before you continue, make sure you’ve completed the steps in Set up Amazon Q in your IDE. Make sure that the following prerequisites are met before you begin a Code Transformation job: • Your project is written in a supported Java version and is built on Maven. • Your project successfully builds with Maven in your IDE. Maven 3.8 or later is currently supported. • Your project source JDK is available locally and is the version of your source code. For example, if you are transforming Java 8 code, your local JDK installation should be JDK 8. • Your project builds in 55 minutes or less. • Your project is conﬁgured correctly, and the correct JDK version is speciﬁed. For more information, see Step 2: Conﬁgure your project. Transforming Java applications 172 Amazon Q Developer User Guide • Your project doesn't require access to resources on your private network, including a virtual private cloud (VPC) or on-premise network. For example, if your project contains unit tests that connect to a database in your network, the transformation will fail. • Your project doesn't use plugins that package languages other than Java in your Java project. For example, if your project uses the frontend-maven-plugin for executing front-end JavaScript
amazonq-developer-ug-056	amazonq-developer-ug.pdf	56	• Your project is conﬁgured correctly, and the correct JDK version is speciﬁed. For more information, see Step 2: Conﬁgure your project. Transforming Java applications 172 Amazon Q Developer User Guide • Your project doesn't require access to resources on your private network, including a virtual private cloud (VPC) or on-premise network. For example, if your project contains unit tests that connect to a database in your network, the transformation will fail. • Your project doesn't use plugins that package languages other than Java in your Java project. For example, if your project uses the frontend-maven-plugin for executing front-end JavaScript code in addition to your Java source code, the transformation will fail. • Your local network allows uploads to Amazon S3 buckets that Amazon Q uses to transform your code. For more information, see Allow access to Amazon S3 buckets in data perimeters. Step 2: Conﬁgure your project To conﬁgure your project, use the following information for the IDE you're using. Conﬁgure a project in JetBrains To conﬁgure your project in JetBrains, you might need to specify the following project and module settings. If your modules use the same JDK and language level as your project, you don't need to update module settings. • Project SDK – The JDK used to compile your project. • Project language level – The Java version used in your project. • Module SDK – The JDK used to compile your module. • Module language level – The Java version used in your module. • Maven Runner JRE – The JDK you build your module with. Update project and module settings To update your SDK and language level settings for your project or module, complete the following steps: 1. 2. From your JetBrains IDE, choose File and then Project Structure. The Project Structure window opens. Under Project Settings, choose Project. a. To update your project JDK, choose from the dropdown list next to SDK. Transforming Java applications 173 Amazon Q Developer User Guide b. To update your project language, choose from the dropdown next to Language level. 3. Under Project Settings, choose Modules. a. b. To update your module JDK, choose from the dropdown list next to SDK. To update your module language, choose from the dropdown next to Language level. For more information, see Project structure settings and Module structure settings in the JetBrains documentation. Update Maven settings To update your Maven Runner JRE, complete the following steps: 1. 2. From your JetBrains IDE, choose the gear icon, and then choose Settings in the menu that appears. In the Settings window, choose Build, Execution, Deployment, then Build Tools, then Maven, and then Runner. 3. In the JRE ﬁeld, choose the JDK used to build the module you're transforming. Conﬁgure a project in VS Code To conﬁgure your project in VS Code, your project must contain the following: • A pom.xml ﬁle in the project root folder • A .java ﬁle in the project directory If your project contains a Maven wrapper executable (mvnw for macOS or mvnw.cmd for Windows), make sure it’s at the root of your project. Amazon Q will use the wrapper, and no other Maven conﬁguration is necessary. If you aren’t using a Maven wrapper, install Maven. For more information, see Installing Apache Maven in the Apache Maven documentation. After installing Maven, add it to your PATH variable. For more information, see How do I add Maven to my PATH? Your Java runtime variable should also be pointing to a JDK and not to a JRE. To conﬁrm your conﬁguration is correct, run mvn -v. The output should show your Maven version and the runtime variable pointing to the path to your JDK. Transforming Java applications 174 Amazon Q Developer Step 3: Transform your code User Guide Before you transform your own code, you might want to test that your IDE is setup correctly by transforming a sample project. Following is a sample GitHub project that is eligible for code transformation: https://github.com/aws-samples/aws-appconﬁg-java-sample. To test your IDE setup, download and unzip the sample project, and complete the following steps for your IDE. If you are able to view the proposed changes and transformation summary, you are ready to transform your own code project. If the transformation fails, your IDE is not conﬁgured correctly. To address conﬁguration issues, review Step 2: Conﬁgure your project and Troubleshooting. Note If you navigate away from your IDE before the transformation starts, the transformation will fail and you will have to restart. To upgrade the language version of your code project or module, complete the following steps for your IDE. JetBrains 1. Open the module that you want to upgrade in JetBrains. Make sure you’ve successfully built your project in the IDE. 2. Choose the Amazon Q logo, and then enter /transform in the Amazon Q chat
amazonq-developer-ug-057	amazonq-developer-ug.pdf	57	project. If the transformation fails, your IDE is not conﬁgured correctly. To address conﬁguration issues, review Step 2: Conﬁgure your project and Troubleshooting. Note If you navigate away from your IDE before the transformation starts, the transformation will fail and you will have to restart. To upgrade the language version of your code project or module, complete the following steps for your IDE. JetBrains 1. Open the module that you want to upgrade in JetBrains. Make sure you’ve successfully built your project in the IDE. 2. Choose the Amazon Q logo, and then enter /transform in the Amazon Q chat panel that opens. 3. A Transform your application pop-up appears. Choose the project that you want to upgrade from the dropdown list, and then choose Transform. 4. Amazon Q begins the transformation. You can view progress on the Transformation details tab. 5. After the transformation is complete, you can verify the upgraded code before updating your project. To view the new code, go to the Transformation details tab and then choose View diﬀ. In the Apply patch window that appears, choose a ﬁle to open a diﬀ view with your source code and upgraded code. 6. To accept the changes that Amazon Q made, choose View diﬀ to open the Apply patch window. Select all the updated ﬁles, and choose OK to update your project in place. Transforming Java applications 175 Amazon Q Developer User Guide 7. To get details about how your code was upgraded and suggested next steps, on the Transformation details tab, choose View transformation summary. Visual Studio Code 1. Open the project or workspace that you want to upgrade in VS Code. Make sure that you’ve successfully built your project in the IDE. 2. Choose the Amazon Q logo, and then enter /transform in the Amazon Q chat panel that opens. 3. Choose the project that you want to upgrade from the search bar at the top of the IDE. 4. 5. If Amazon Q can’t ﬁnd the version of your source code, it prompts you to choose your code version. Choose the version that your source code is written in, and then choose Transform in the pop-up to proceed. If prompted, enter the JAVA_HOME path to your JDK. For more information, see Conﬁgure your VS Code project. 6. Amazon Q begins the transformation. You can view progress on the Transformation Hub tab. 7. After the transformation is complete, the Proposed Changes tab opens. To verify the upgraded code before updating your project, choose Download proposed changes. Choose a ﬁle to open a diﬀ view with your source code and upgraded code. 8. 9. To accept the changes Amazon Q made, go to the Proposed Changes tab and choose Accept. To get details about how your code was upgraded and suggested next steps, on the Transformation Hub, choose the Views and More Actions ellipsis button, and then choose Show Transformation Summary. How Amazon Q Developer transforms code for Java language upgrades To transform your code, Amazon Q Developer generates a transformation plan that it uses to upgrade the code language version of your project. After transforming your code, it provides a transformation summary and a ﬁle diﬀ for you to review changes before accepting them. The following sections provide more details on how Amazon Q performs the transformation. Transforming Java applications 176 Amazon Q Developer User Guide Building your code and creating a transformation plan To begin transforming your code, Amazon Q builds your project locally and generates a build artifact that contains your source code, project dependencies, and build logs. After generating the build artifact, Amazon Q builds your code in a secure build environment and creates a transformation plan, which is customized to the project or module you’re upgrading. The transformation plan outlines the speciﬁc changes Amazon Q will attempt to make, including new dependency versions, major code changes, and suggested replacements for deprecated code. These changes are based on the preliminary build of your code, and might change during the transformation. Before the transformation begins, you have the option to split up the changes Amazon Q proposes into multiple diﬀs. This allows you to update and test your code with fewer changes at a time, and will require you to accept changes incrementally after the transformation is complete. Transforming your code To transform your code, Amazon Q attempts to upgrade your code to the target Java version based on the proposed changes in the transformation plan. As it makes changes, it re-builds and runs existing unit tests in your source code to iteratively ﬁx any encountered errors. Amazon Q attempts to make the following changes when upgrading your code: • Update deprecated code components according to the target Java version recommendations • Upgrade popular libraries and frameworks to a version compatible with the
amazonq-developer-ug-058	amazonq-developer-ug.pdf	58	a time, and will require you to accept changes incrementally after the transformation is complete. Transforming your code To transform your code, Amazon Q attempts to upgrade your code to the target Java version based on the proposed changes in the transformation plan. As it makes changes, it re-builds and runs existing unit tests in your source code to iteratively ﬁx any encountered errors. Amazon Q attempts to make the following changes when upgrading your code: • Update deprecated code components according to the target Java version recommendations • Upgrade popular libraries and frameworks to a version compatible with the target Java version. This includes updating the following libraries and frameworks to their latest available major versions: • Apache Commons IO • Apache HttpClient • bc-ﬁps • Cucumber-JVM • Hibernate • jackson-annotations • JakartaEE • Javax • javax.servlet Transforming Java applications 177 User Guide Amazon Q Developer • jaxb-api • jaxb-impl • jaxen • jcl-over-slf4j • json-simple • jsr305 • junit • junit-jupiter-api • Log4j • Micronaut • Mockito • mockito-core • Okio • PowerMockito • Quarkus • slf4j • slf4j-api • Spring Boot • Spring Framework • Spring Security • Swagger • testng Reviewing the transformation summary and accepting changes After the transformation is complete, Amazon Q provides a transformation summary with details about the changes it made, including the status of the ﬁnal build which indicates whether your entire project was upgraded. You can also view a build log summary to understand any issues that prevented Amazon Q from building your code in the upgraded version. The transformation summary additionally includes the diﬀerences between the changes proposed in the transformation plan and the changes Amazon Q ultimately made to upgrade your code, and any additional changes that weren’t in the original plan. Transforming Java applications 178 Amazon Q Developer User Guide After you review the transformation summary, you can view the changes Amazon Q is proposing in a ﬁle diﬀ view. Any code changes Amazon Q suggests will not aﬀect your current project ﬁles until you accept the changes. The transformed code is available up to 30 days after the transformation completes. If you chose to have Amazon Q split up the changes into multiple diﬀs, it will provide one or more diﬀs with changes, depending on the upgrades required for your application. If applicable to your application, the changes are categorized in the following groups: • Minimum compatible library versions to the target Java version: Upgrade dependencies, including Springboot, JUnit, and PowerMockito, to the minimum compatible versions in the target Java version. • Popular enterprise speciﬁcations application frameworks: Upgrade popular enterprise and application frameworks like Jakarta EE, Hibernate, and Micronaut 3. • HTTP client utilities web frameworks: Upgrade HTTP client libraries, Apache Commons utilities, and Struts frameworks. • Testing tools frameworks: Upgrade testing tools like ArchUnit, Mockito, and TestContainers and build tools like Jenkins and Maven Wrapper. • Miscellaneous processing documentation: Multiple types of upgrades, including ORMs, XML processing, and API documentation like Swagger to SpringDoc/OpenAPI. • Deprecated APIs, outdated dependencies, and formatting: Replace deprecated APIs, make additional dependency version upgrades, and format code changes Amazon Q will provide one diﬀ ﬁle at a time, and you must accept changes in a diﬀ to review the following diﬀ. If you reject changes in a diﬀ, you won’t be able to review any other diﬀs. After you accept changes from one diﬀ, you can review the updates to your code and test the changes before continuing to accept subsequent changes. Note that there may be minor version downgrades across the diﬀs. For example, you may see a dependency version upgraded to a newer version in the ﬁrst diﬀ, and in a subsequent diﬀ see an older version of the dependency. This is because Amazon Q might need to adjust versions to accommodate changes made in each diﬀ. After you accept changes from all the diﬀs, your code will contain the most recent reliable versions. The title of the diﬀ will indicate whether the proposed changes will result in a full or partial transformation. If the diﬀ indicates the transformation was only partially successful, then it does not include all necessary changes for a complete transformation and a successful code build. To Transforming Java applications 179 Amazon Q Developer User Guide get the most upgraded version of your code, accept all the code diﬀs, including partially successful ones. Then, you can manually update your code to address the errors Amazon Q wasn’t able to ﬁx. Completing partially successful transformations Depending on the complexity and speciﬁcs of your codebase, there might be instances where the transformation is partially successful. This means that Amazon Q was able to transform only certain ﬁles or areas of code in your project. In this case, you have to manually update the remaining code for
amazonq-developer-ug-059	amazonq-developer-ug.pdf	59	code build. To Transforming Java applications 179 Amazon Q Developer User Guide get the most upgraded version of your code, accept all the code diﬀs, including partially successful ones. Then, you can manually update your code to address the errors Amazon Q wasn’t able to ﬁx. Completing partially successful transformations Depending on the complexity and speciﬁcs of your codebase, there might be instances where the transformation is partially successful. This means that Amazon Q was able to transform only certain ﬁles or areas of code in your project. In this case, you have to manually update the remaining code for your project to be buildable in the updated language version. To help transform the rest of your code, you can use Amazon Q chat in the IDE. You can ask Amazon Q to review the partially updated ﬁles and provide new code to address issues, such as compilation errors. You can also use features like /dev and @workspace to include more of your project as context and get suggestions for multiple ﬁles at a time. Converting embedded SQL in Java applications with Amazon Q Developer The Amazon Q Developer agent for code transformation in the IDE can help you convert embedded SQL to complete Oracle to PostgreSQL database migration with AWS Database Migration Service (AWS DMS). AWS DMS is a cloud service that makes it possible to migrate relational databases, data warehouses, NoSQL databases, and other types of data stores. DMS Schema Conversion in AWS DMS helps you convert database schemas and code objects that you can apply to your target database. For more information, see What is AWS Database Migration Service? in the AWS Database Migration Service User Guide. When you use AWS DMS and DMS Schema Conversion to migrate a database, you might need to convert the embedded SQL in your application to be compatible with your target database. Rather than converting it manually, you can use Amazon Q in the IDE to automate the conversion. Amazon Q uses metadata from a DMS Schema Conversion to convert embedded SQL in your application to a version that is compatible with your target database. Currently, Amazon Q can convert SQL in Java applications for Oracle databases migrating to PostgreSQL. You will only see the option to transform SQL code in the IDE if your application contains Oracle SQL statements. See the prerequisites for more information. Step 1: Prerequisites Before you continue, make sure you’ve completed the steps in Set up Amazon Q in your IDE. Transforming Java applications 180 Amazon Q Developer User Guide Before you begin a code transformation job for SQL conversion, make sure the following prerequisites are met: • You are migrating a Java application with embedded SQL from an Oracle database to a PostgreSQL database. Your application must contain Oracle SQL statements for it to be eligible for transformation. • You have completed the process for converting your database schema using AWS DMS Schema Conversion. For more information, see Migrating Oracle databases to Amazon RDS for PostgreSQL with DMS Schema Conversion in the Database Migration Guide. • After schema conversion is complete, you have downloaded the migration project ﬁle from the AWS DMS console. Step 2: Conﬁgure your application To convert your embedded SQL code, your Java project must contain at least one .java ﬁle. If you are using a JetBrains IDE, you must set the SDK ﬁeld in Project Structure settings to the applicable JDK. For information on conﬁguring Project Structure settings, see Project structure settings in the JetBrains documentation. Step 3: Convert embedded SQL To convert the embedded SQL code in your Java application to a format that is compatible with your PostgreSQL target database, complete the following steps: 1. In your IDE where Amazon Q is installed, open the Java codebase that contains the embedded SQL you need to convert. 2. Choose the Amazon Q icon to open the chat panel. 3. 4. Enter /transform in the chat panel. If your Java application is eligible for SQL conversion, Amazon Q will prompt you to choose which type of transformation you'd like to perform. Enter SQL conversion. 5. Amazon Q prompts you to upload the schema metadata ﬁle you retrieved from Amazon S3. In the chat, Amazon Q provides instructions for retrieving the ﬁle. 6. Amazon Q prompts you to provide the project that contains the embedded SQL as well as the database schema ﬁle. Choose the appropriate ﬁles from the dropdown menus in the chat panel. Transforming Java applications 181 Amazon Q Developer User Guide 7. Conﬁrm the details Amazon Q retrieved from the database schema are accurate. 8. Amazon Q begins converting your SQL code. This might take a few minutes. 9. After Amazon Q converts the SQL code, it provides a diﬀ with any updates it has made to your ﬁles.
amazonq-developer-ug-060	amazonq-developer-ug.pdf	60	the chat, Amazon Q provides instructions for retrieving the ﬁle. 6. Amazon Q prompts you to provide the project that contains the embedded SQL as well as the database schema ﬁle. Choose the appropriate ﬁles from the dropdown menus in the chat panel. Transforming Java applications 181 Amazon Q Developer User Guide 7. Conﬁrm the details Amazon Q retrieved from the database schema are accurate. 8. Amazon Q begins converting your SQL code. This might take a few minutes. 9. After Amazon Q converts the SQL code, it provides a diﬀ with any updates it has made to your ﬁles. Review the changes in the diﬀs, and then accept the changes to update your code. Amazon Q also provides a transformation summary with details about the changes it made. 10. After updating your code, return to the AWS DMS console to verify the new SQL is compatible with the migrated database. Transforming code on the command line with Amazon Q Developer Transforming code with Amazon Q on the command line is in preview, and is subject to change. You can transform your applications from the command line with the Amazon Q Developer command line transformation tool. To transform your code, you provide the path to your source code and any necessary conﬁguration ﬁles, and Amazon Q generates new code in a series of steps. Throughout the transformation, Amazon Q builds code on your local environment to verify changes. For more information, see Building code in your local environment. Amazon Q creates a new branch in your repository where it commits the code changes. When the transformation is complete, you can merge the branch into your original branch to incorporate the changes into your codebase. In addition to the transformation Amazon Q runs, you have the option to create custom transformations to make changes unique to your organization’s code. For more information, see Customizing transformations on the command line with Amazon Q Developer. To get started, install the command line tool and authenticate, and then see the commands to conﬁgure and start a transformation. Topics • Building code in your local environment • Commands • Running a transformation on the command line with Amazon Q Developer • Customizing transformations on the command line with Amazon Q Developer • Amazon Q Developer command line transformation tool version history Transforming Java applications 182 Amazon Q Developer User Guide Building code in your local environment During a transformation, Amazon Q performs veriﬁcation builds in your local environment. Amazon Q transforms your code on the server side in multiple steps. After each step, Amazon Q sends the code to your local environment to build and test the changes it made. The code is then sent back to the server side to continue the transformation. The build in your local environment helps verify the transformed code by allowing Amazon Q to run tests that require access to private resources. To minimize security risks associated with building AI-generated code in your local environment, Amazon Q reviews and updates the code it generates to address security concerns. Commands For step-by-step instructions for running these commands, see Running a transformation on the command line with Amazon Q Developer. To conﬁgure a transformation and authenticate to Amazon Q Developer Pro, run: qct configure To start a transformation for a Java upgrade, run the following command. For <your-target- java-version>, you can enter either JAVA_17 or JAVA_21. qct transform --source_folder <path-to-folder> --target_version <your-target-java-version> To start a transformation for a SQL conversion, run: qct transform --source_folder <path-to-folder> --sql_conversion_config_file <path-to-sql-config-file> To start a transformation with a customization, run: qct transform --source_folder <path-to-folder> --custom_transformation_file <path-to-orchestrator-file> To get help with transformations, run: Transforming Java applications 183 Amazon Q Developer qct -h User Guide Running a transformation on the command line with Amazon Q Developer Transforming code with Amazon Q on the command line is in preview, and is subject to change. Complete these steps to transform your code on the command line with the Amazon Q Developer command line tool. Prerequisites Before you begin a transformation on the command line, the following prerequisites must be met: • If you're upgrading your Java code version, your project meets the prerequisites for upgrading Java versions with Amazon Q. • If you're converting embedded SQL in a Java application, your application meets the prerequisites for converting embedded SQL with Amazon Q. • You have Python installed on your command line environment. This is how you will install the command line tool. The minimum supported Python version is 3.12. • You are running the transformation on macOS or Linux. • The size of your application is 2 GB or smaller. • If you are performing custom transformations, you have installed the ast-grep tool. To install and set up ast-grep, see Installation in the ast-grep documentation. Step 1: Choose authentication method
amazonq-developer-ug-061	amazonq-developer-ug.pdf	61	• If you're converting embedded SQL in a Java application, your application meets the prerequisites for converting embedded SQL with Amazon Q. • You have Python installed on your command line environment. This is how you will install the command line tool. The minimum supported Python version is 3.12. • You are running the transformation on macOS or Linux. • The size of your application is 2 GB or smaller. • If you are performing custom transformations, you have installed the ast-grep tool. To install and set up ast-grep, see Installation in the ast-grep documentation. Step 1: Choose authentication method and add permissions You can authenticate with AWS Identity and Access Management (IAM) or IAM Identity Center to run transformations on the command line. Regardless of the authentication method you use, ensure you have the proper permissions. Note Customer managed keys aren't supported for transformations performed on the command line. Transforming Java applications 184 Amazon Q Developer Add permissions User Guide The IAM identity associated with either the AWS CLI proﬁle or the Amazon Q Developer subscription you are using to authenticate must have permissions to perform transformations on the command line. Before you proceed, ensure your IAM identity has the permissions deﬁned in Allow users to run transformations on the command line. Authenticate with IAM Note You can't use IAM to authenticate with a Amazon Q Developer subscription. To authenticate with IAM, you must: • Install the AWS Command Line Interface (AWS CLI). For more information, see Getting started with the AWS CLI. • Conﬁgure an AWS CLI proﬁle with a credentials ﬁle where your IAM credentials are stored. For more information on adding your IAM credentials to your AWS CLI proﬁle, see Conﬁguration and credential ﬁle settings in the AWS CLI. • Add the required permissions to your IAM identity. For more information, see Add permissions. You can specify this conﬁguration on your command line by running aws configure after installing the AWS CLI. You provide the AWS CLI proﬁle you conﬁgured in Step 3: Conﬁgure and authenticate. Authenticate with IAM Identity Center through a Amazon Q Developer subscription To authenticate with IAM Identity Center, you must be subscribed to Amazon Q Developer Pro and provide the Start URL to authenticate through your subscription. You or your administrator can ﬁnd the Start URL in the Amazon Q Developer console. For more information see, Managing account details in Amazon Q Developer. To add required permissions, see Add permissions. You provide the Start URL in Step 3: Conﬁgure and authenticate. Transforming Java applications 185 Amazon Q Developer Step 2: Install the tool User Guide 1. Download the Amazon Q command line tool for transformations. To download a previous version of the command line tool, see Version history. 2. We recommend that you set up a virtual environment in Python to install the tool. To create a virtual environment, open a terminal window and run: python -m venv qct-cli 3. To activate the virtual environment, run: source qct-cli/bin/activate 4. To install the tool on your command line, run: pip install amzn_qct_cli-0.5.2-py3-none-any.whl Note If you are using an older version of the command line tool for transformations, replace 0.5.2 with the version you downloaded. 5. To verify that the tool was installed, run: which qct Step 3: Conﬁgure and authenticate Before you can begin a transformation, you must authenticate to the AWS CLI and provide conﬁguration details for your transformation. 1. If you're authenticating with IAM and you haven't already conﬁgured the AWS CLI, run the following command to provide authentication details. For requirements to authenticate with IAM on the AWS CLI, see Authenticate with IAM. aws configure Transforming Java applications 186 Amazon Q Developer User Guide 2. To start the transformation conﬁguration process, run the following command: qct configure 3. First, your Maven version is veriﬁed. If you have at least the minimum supported version, you will see the following output: Running command: mvn --version at: path/to/current/directory Your Maven version is supported for transformations. If you don’t have a supported version of Maven, you must update it to continue. For more information, see the Prerequisites. 4. You are then prompted to enter a JDK path for each supported Java version. You only need to specify the path to the JDK of the Java version you are upgrading. 5. Next, you are prompted to choose your authentication method. a. To authenticate with IAM credentials stored in your AWS CLI proﬁle, enter 1. You can specify a speciﬁc proﬁle name or press enter to use the default proﬁle. If you'd like to add tags to your transformation, you can supply a CSV ﬁle where your tags are stored. The CSV must have two columns, with headers titled key and value, where tag key-value pairs are listed. To add these tags to your transformation,
amazonq-developer-ug-062	amazonq-developer-ug.pdf	62	only need to specify the path to the JDK of the Java version you are upgrading. 5. Next, you are prompted to choose your authentication method. a. To authenticate with IAM credentials stored in your AWS CLI proﬁle, enter 1. You can specify a speciﬁc proﬁle name or press enter to use the default proﬁle. If you'd like to add tags to your transformation, you can supply a CSV ﬁle where your tags are stored. The CSV must have two columns, with headers titled key and value, where tag key-value pairs are listed. To add these tags to your transformation, enter the path to the CSV ﬁle where tags are stored. b. To authenticate with IAM Identity Center through your Amazon Q Developer subscription, enter 2, and then enter the start URL for your subscription proﬁle. Next, enter the AWS Region where you were subscribed in the following format: us- east-1. For a list of supported Regions, see Supported Regions. For a list of Region codes, see Regional endpoints in the AWS General Reference guide. 6. If you're upgrading your code's Java version, you have the option to receive your code suggestions from Amazon Q in one commit or multiple commits. Amazon Q will split the upgraded code into multiple commits by default. If you want all your code changes to appear in one commit, enter the letter 'O' for one commit when prompted. For more information on how Amazon Q splits up the code changes, see Reviewing the transformation summary and accepting changes. 7. Your conﬁguration preferences are saved to a conﬁguration.ini ﬁle. Transforming Java applications 187 Amazon Q Developer Step 4: Run a transformation User Guide Choose the type of transformation you're performing to see the required conﬁguration and commands. For information on running custom transformations, see Customizing transformations. Java upgrade 1. Run the following command to start a transformation for a Java upgrade. Replace <path- to-folder> with the path to the folder with the code you're transforming and <your- target-java-version> with either JAVA_17 or JAVA_21. qct transform --source_folder <path-to-folder> --target_version <your-target-java-version> 2. Amazon Q begins the transformation. It will output status updates throughout the transformation. When it’s complete, Amazon Q provides the path where the transformation results, logs, and conﬁguration ﬁles are outputted. Your upgraded code will be committed to the new branch Amazon Q created. Amazon Q will commit the code in one or multiple commits, depending on the selection you made when you ran qct configure. SQL conversion Before you begin, make you sure you've read Converting embedded SQL in Java applications with Amazon Q Developer to understand the prerequisites for this type of transformation. 1. To convert embedded SQL, you must ﬁrst create a YAML ﬁle that contains the path to the schema metadata ﬁle from your AWS DMS Schema Conversion. Following is the required format of the ﬁle: schema_conv_metadata_path: <path-to-metadata-zip-file> 2. Run the following command to start a transformation for a SQL conversion. Replace <path-to-folder> with the path to the folder with the code you're transforming and <path-to-sql-config-file> with the path to the YAML ﬁle you created in step 1. Transforming Java applications 188 Amazon Q Developer User Guide qct transform --source_folder <path-to-folder> --sql_conversion_config_file <path-to-sql-config-file> 3. If Amazon Q ﬁnds multiple schemas in your schema metadata ﬁle, it will stop the transformation and provide a list of the detected schemas. Choose which schema to use for the SQL conversion, and then add a new ﬁeld schema: <schema-name> to the YAML ﬁle. 4. Amazon Q begins the transformation. It will output status updates throughout the transformation. When it’s complete, Amazon Q provides the path where the transformation results, logs, and conﬁguration ﬁles are outputted. Your upgraded code will be committed to the new branch Amazon Q created. Customizing transformations on the command line with Amazon Q Developer Transforming code with Amazon Q on the command line is in preview, and is subject to change. Note This feature is only available when performing Java code version upgrades on the command line. You can customize transformations by providing custom logic in the form of ast-grep rules that Amazon Q uses to make changes to your code. ast-grep is an abstract syntax tree tool that can be used to rewrite code. Amazon Q leverages ast-grep to run customized transformations. For more information, see What is ast-grep? in the ast-grep documentation. Amazon Q performs the custom transformation locally. The custom transformation happens in addition to the Java upgrades in an Amazon Q transformation. To conﬁgure a custom transformation, you provide two ﬁle types that specify the custom logic: • An orchestrator ﬁle, where you deﬁne what custom transformations to run before the Amazon Q transformation, and which ones to run after • One or more custom transformation ﬁles, where you deﬁne an ast-grep rule Transforming Java applications 189
amazonq-developer-ug-063	amazonq-developer-ug.pdf	63	used to rewrite code. Amazon Q leverages ast-grep to run customized transformations. For more information, see What is ast-grep? in the ast-grep documentation. Amazon Q performs the custom transformation locally. The custom transformation happens in addition to the Java upgrades in an Amazon Q transformation. To conﬁgure a custom transformation, you provide two ﬁle types that specify the custom logic: • An orchestrator ﬁle, where you deﬁne what custom transformations to run before the Amazon Q transformation, and which ones to run after • One or more custom transformation ﬁles, where you deﬁne an ast-grep rule Transforming Java applications 189 Amazon Q Developer User Guide After creating an orchestrator ﬁle and your custom transformation ﬁles, you can start a transformation job with the customization option and the path to your orchestrator ﬁle. Following is the command you run to start a transformation with a custom transformation: qct transform --source_folder <path-to-folder> --custom_transformation_file <path-to-orchestrator-file> Orchestrator ﬁles An orchestrator ﬁle is a YAML ﬁle where you provide the paths to the custom transformation ﬁles that Amazon Q will run, and specify when to run the rules (before or after the Amazon Q transformation). The following ﬁelds are required in the transformation ﬁle: • name • description • At least one of the following: • To run a custom transformation before the Amazon Q transformation, add the path to a custom transformation ﬁle under pre_qct_actions: • To run a custom transformation after the Amazon Q transformation, add the path to a custom transformation ﬁle under post_qct_actions: Following is an example of the syntax in an orchestrator ﬁle: name: custom_change_1 description: My collection of custom transformations to run before and after a transformation. pre_qct_actions: ast-grep: rules: - /path/to/custom-transformation3.yaml - /path/to/custom-transformation2.yaml post_qct_actions: ast-grep: rules: - /path/to/custom-transformation3.yaml Transforming Java applications 190 Amazon Q Developer Custom transformation ﬁles User Guide Custom transformation ﬁles are YAML ﬁles where you deﬁne the code changes you want Amazon Q to make in the form of an ast-grep rule. Amazon Q only supports ast-grep compatible rules for custom transformations. Amazon Q can run custom transformations before or after it runs a transformation. See the following guidance on when custom transformation types should be run: • Custom transformations you run before the Amazon Q transformation should focus on code preprocessing tasks. Your code must be compilable after the custom transformations are run in order to continue with the Amazon Q transformation. • Custom transformations run after the Amazon Q transformation can involve tasks like upgrading internal libraries or other tasks related to private resources. If these tasks break the code build, Amazon Q can debug and ﬁx issues that arise from the custom transformation. Following is an example of a custom transformation ﬁle with an ast-grep rule: id: no-unused-vars language: java rule: kind: local_variable_declaration all: - has: has: kind: identifier pattern: $IDENT - not: precedes: stopBy: end has: stopBy: end any: - { kind: identifier, pattern: $IDENT } - { has: {kind: identifier, pattern: $IDENT, stopBy: end}} fix: '' You can learn more about how this example works at https://ast-grep.github.io/catalog/java/. Transforming Java applications 191 Amazon Q Developer User Guide Amazon Q Developer command line transformation tool version history Transforming code with Amazon Q on the command line is in preview, and is subject to change. Review the following information for details about current and past releases of the Amazon Q Developer command line transformation tool. The table includes the download link, release date, and release notes for each version. Version Release date Release notes 0.5.2 (latest) April 16, 2025 0.5.1 (latest) March 13, 2025 0.5.0 0.4.1 February 28, 2025 February 17, 2025 0.4.0 February 14, 2025 Bug ﬁxes to resolve issues when resuming jobs and failures for applications with ﬁrst-party dependencies. When you authenticate with IAM, you no longer need to provide an AWS Region. Also includes bug ﬁx to include job status in output logs. Includes support for authentic ating with IAM through the AWS CLI. Bug ﬁx to include support for entering the AWS Region where your Amazon Q Developer subscription is conﬁgured. Includes support for upgrading Java applications to Java 21. Transforming Java applications 192 Amazon Q Developer Version 0.3.0 0.2.0 0.1.0 Release date Release notes User Guide February 12, 2025 February 3, 2025 November 27, 2024 Includes support for convertin g embedded SQL in Java applications. Includes support for receiving upgraded Java code in multiple commits. Initial release. Includes support for upgrading Java code versions from the command line and customizi ng transformations. Troubleshooting issues with Java transformations The following information can help you troubleshoot common issues when transforming Java applications with Amazon Q Developer. Topics • Why can't Amazon Q upload my project? • Why are my Maven commands failing? • How do I add Maven to my PATH? • Why can't Amazon Q build my code? •
amazonq-developer-ug-064	amazonq-developer-ug.pdf	64	2025 February 3, 2025 November 27, 2024 Includes support for convertin g embedded SQL in Java applications. Includes support for receiving upgraded Java code in multiple commits. Initial release. Includes support for upgrading Java code versions from the command line and customizi ng transformations. Troubleshooting issues with Java transformations The following information can help you troubleshoot common issues when transforming Java applications with Amazon Q Developer. Topics • Why can't Amazon Q upload my project? • Why are my Maven commands failing? • How do I add Maven to my PATH? • Why can't Amazon Q build my code? • Why did my transformation fail after 55 minutes? • Why can’t I download my transformed code? • How do I access code transformation logs? • How do I ﬁnd my transformation job ID? Why can't Amazon Q upload my project? If your project fails to upload, it’s likely due to one of the following issues. See the topic that corresponds to the error you see from Amazon Q. Transforming Java applications 193 Amazon Q Developer Topics • Reduce project size • Conﬁgure proxy settings in your IDE • Allow access to Amazon S3 Reduce project size User Guide To transform your code, Amazon Q generates a project artifact, which includes your source code, project dependencies, and build logs. The maximum project artifact size for a transformation job is 2 GB. If you get an error related to project artifact size, you must decrease the size of your project or try transforming a smaller project. You can view the size of your project artifact ﬁle in the code transformation logs. For more information, see How do I access code transformation logs? Conﬁgure proxy settings in your IDE To transform your code, Amazon Q uploads your project artifact to a service-owned Amazon S3 bucket. Part of the upload process involves using SSL or TLS certiﬁcates to establish communication between Amazon S3 and your IDE. If you are using a proxy server, the SSL or TLS certiﬁcates used by your proxy server must be trusted, otherwise Amazon Q is not able to upload your project. If you receive an error related to your proxy or certiﬁcates, you likely need to conﬁgure your IDE or operating system to trust your certiﬁcates or update other proxy settings. Note You might also encounter issues unrelated to certiﬁcates if you are behind your organization’s proxy server or ﬁrewall. If you complete the following procedures to conﬁgure your certiﬁcates and still have issues, contact your network administrator to ensure you are allowed to communicate with Amazon S3 from your IDE. For more information, see Allow access to Amazon S3. Conﬁgure certiﬁcates in JetBrains To conﬁgure your JetBrains IDE Java Runtime Environment (JRE) to trust the SSL or TLS certiﬁcates used by your proxy server, you must import the SSL or TLS certiﬁcates to the cacerts ﬁle in the JRE. The cacerts ﬁle is a ﬁle that contains trusted root certiﬁcates for secure connections such Transforming Java applications 194 Amazon Q Developer User Guide as HTTPS and SSL, and it's part of the JRE's security settings. To import a certiﬁcate, complete the following procedure. Note We recommend making a backup of the cacerts ﬁle before modifying it, as any mistakes can cause issues with secure connections. 1. Determine the path to the cacerts ﬁle in your JRE. The path of the cacerts ﬁle in the internal JRE shipped with your JetBrains IDE depends on the operating system and the version of the JetBrains IDE you’re using. Following are examples of paths to the cacerts ﬁle in common operating systems. Choose your operating system to see examples. Note <JetBrains Installation Folder> refers to the directory where JetBrains products are installed. This directory is typically chosen during the installation process. The jbr folder represents the JRE bundled with JetBrains IDEs, which is a speciﬁc version of the JRE tailored for use with JetBrains IDEs. Windows The cacerts ﬁle path for a JetBrains IDE installed on Windows is: <JetBrains Installation Folder>\jbr\bin\cacerts For example, if you installed a JetBrains IDE on Windows in the default location, the path might be: C:\Program Files\JetBrains\jbr\bin\cacerts macOS The cacerts ﬁle path for a JetBrains IDE installed on macOS is: Transforming Java applications 195 Amazon Q Developer User Guide /Applications/JetBrains Toolbox/<version>/JetBrains Toolbox.app/Contents/jbr/ Contents/Home/lib/security/cacerts For example, if you installed a JetBrains IDE on macOS in the default location, the path might be: /Applications/JetBrains Toolbox/2022.3.4/JetBrains Toolbox.app/Contents/jbr/ Contents/Home/lib/security/cacerts Linux The cacerts ﬁle path for a JetBrains IDE installed on Linux is: /opt/jetbrains/jbr/lib/security/cacerts 2. Determine the certiﬁcate you need to import to the cacerts ﬁle. The certiﬁcate ﬁle typically has a .cer, .crt, or .der ﬁle extension. If you aren’t sure which certiﬁcates you need to add, contact your network administrator. 3. Import the certiﬁcate to the cacerts keystore. You can do
amazonq-developer-ug-065	amazonq-developer-ug.pdf	65	macOS is: Transforming Java applications 195 Amazon Q Developer User Guide /Applications/JetBrains Toolbox/<version>/JetBrains Toolbox.app/Contents/jbr/ Contents/Home/lib/security/cacerts For example, if you installed a JetBrains IDE on macOS in the default location, the path might be: /Applications/JetBrains Toolbox/2022.3.4/JetBrains Toolbox.app/Contents/jbr/ Contents/Home/lib/security/cacerts Linux The cacerts ﬁle path for a JetBrains IDE installed on Linux is: /opt/jetbrains/jbr/lib/security/cacerts 2. Determine the certiﬁcate you need to import to the cacerts ﬁle. The certiﬁcate ﬁle typically has a .cer, .crt, or .der ﬁle extension. If you aren’t sure which certiﬁcates you need to add, contact your network administrator. 3. Import the certiﬁcate to the cacerts keystore. You can do this with the Java keytool command. a. Open a command prompt and enter the following command: keytool -import -alias <alias> -file <certificate_file> -keystore <path_to_cacerts> b. c. d. For <alias>, you can add a name for the certiﬁcate you are importing to refer to it later. This option is optional. For <certificate_file>, specify the path to the certiﬁcate you are importing. This should be a path to the .cer, .crt, or .der ﬁle containing the certiﬁcate. For <path_to_cacerts>, specify the path to the cacerts keystore ﬁle you saved in step 1. This is the ﬁle where you are importing the certiﬁcate. For example, if you want to import a certiﬁcate named my_certificate.cer into the cacerts keystore of the bundled JRE in IntelliJ IDEA on Windows, and you want to give the alias myalias to the certiﬁcate, the command might be: Transforming Java applications 196 Amazon Q Developer User Guide keytool -import -alias myalias -file my_certificate.cer -keystore "C:\Program Files \JetBrains\IntelliJ IDEA 2022.3.2\jbr\bin\cacerts" 4. During the import process, you'll be prompted to enter the keystore password. The default password for the cacerts keystore is changeit. 5. After running the command, you'll be asked to trust the certiﬁcate. To conﬁrm the certiﬁcate is trusted and complete the import, enter yes. 6. You might also need to add the certiﬁcates to the IDE itself, in addition to the JRE. For more information, see Server Certiﬁcates in the JetBrains documentation. Conﬁgure certiﬁcates in Visual Studio Code To conﬁgure Visual Studio Code to trust the SSL or TLS certiﬁcates used by your proxy server, make sure you have conﬁgured the following proxy settings for your operating system. Conﬁgure certiﬁcates in Visual Studio Code on macOS Conﬁgure the following proxy settings for Visual Studio Code on macOS. Add certiﬁcates to your macOS keychain If you haven’t already, you must add the certiﬁcates used by your proxy server to your macOS keychain. For information on adding certiﬁcates to your keychain, see Add certiﬁcates to a keychain using Keychain Access on Mac in the Keychain Access User Guide. Install the Mac CA VSCode extension The Mac CA VSCode extension allows Amazon Q to access the certiﬁcates you added to Keychain Access on your Mac. To install the extension: 1. Search for mac-ca-vscode in the VS Code extensions pane, and choose Install. 2. Restart VS Code. Update proxy settings in VS Code on macOS Update the following settings to make sure VS Code is conﬁgured properly for your proxy. 1. Open settings in VS Code. Transforming Java applications 197 Amazon Q Developer User Guide 2. 3. Enter proxy in the search bar. In the Http: Proxy ﬁeld, add your proxy URL. 4. Deselect Http: Proxy Strict SSL. 5. 6. In the Http: Proxy Support dropdown list, choose on. In the settings search bar, enter http.experimental.systemCertificatesV2. Select Http › Experimental: System Certiﬁcates V2. Conﬁgure certiﬁcates in Visual Studio Code on Windows Conﬁgure the following proxy settings for Visual Studio Code on Windows. Add certiﬁcate as a trusted root certiﬁcate on Windows If you haven't already, you must add the certiﬁcates used by your proxy server to your Trusted Root Certiﬁcation Authorities store on Windows. To add a certiﬁcate, complete the following procedure: 1. Open the search tool or a Run command window. 2. Enter the following to open the Certiﬁcate Manager tool: certmgr.msc 3. Choose the Trusted Root Certiﬁcation Authorities store. 4. Right-click Certiﬁcates, choose All Tasks, and then choose Import.... 5. Follow the instructions given to import your proxy certiﬁcate. 6. After you've imported your certiﬁcate, conﬁrm the certiﬁcate was added. In the Trusted Root Certiﬁcation Authorities store, double click Certiﬁcates. Right-click the certiﬁcate you added and choose Properties. Under Certiﬁcate purposes, the option Enable all purposes for this certiﬁcate should be selected. Install the Win-CA VSCode extension The Win-CA VSCode extension allows Amazon Q to access the certiﬁcates you added to Trusted Root Certiﬁcates in Windows. To install the extension: 1. Search for win-ca in the VS Code settings pane. Transforming Java applications 198 Amazon Q Developer User Guide 2. In the Inject dropdown list, choose append. Update proxy settings in VS Code on Windows Update the following settings to make sure VS Code is conﬁgured properly for your proxy.
amazonq-developer-ug-066	amazonq-developer-ug.pdf	66	Right-click the certiﬁcate you added and choose Properties. Under Certiﬁcate purposes, the option Enable all purposes for this certiﬁcate should be selected. Install the Win-CA VSCode extension The Win-CA VSCode extension allows Amazon Q to access the certiﬁcates you added to Trusted Root Certiﬁcates in Windows. To install the extension: 1. Search for win-ca in the VS Code settings pane. Transforming Java applications 198 Amazon Q Developer User Guide 2. In the Inject dropdown list, choose append. Update proxy settings in VS Code on Windows Update the following settings to make sure VS Code is conﬁgured properly for your proxy. 1. Open settings in VS Code. 2. 3. Enter proxy in the search bar. In the Http: Proxy ﬁeld, add your proxy URL. 4. Deselect Http: Proxy Strict SSL. 5. 6. In the Http: Proxy Support dropdown list, choose on. In the settings search bar, enter http.experimental.systemCertificatesV2. Select Http › Experimental: System Certiﬁcates V2. 7. Restart VS Code. Allow access to Amazon S3 During a transformation, Amazon Q uploads your code to a service-owned Amazon S3 bucket. If your network or organization hasn’t conﬁgured access to Amazon S3, Amazon Q isn’t able to upload your project. To ensure Amazon Q can upload your project, make sure your proxy conﬁguration and other network components, such as Data Lost Prevention (DLP) policies, are conﬁgured to allow access to Amazon S3. You might also need to allowlist the Amazon S3 bucket where Amazon Q uploads your project. For more information, see Amazon S3 bucket URLs and ARNs to allowlist. If you transform a large project, DLP policies or other network components might cause delays and prevent a successful upload if they aren’t conﬁgured to allowlist the Amazon S3 bucket. If you choose not to allowlist the bucket, you might need to transform a smaller project so that Amazon Q can upload it. Why are my Maven commands failing? Following are Maven conﬁguration issues that you might see in the JetBrains and Visual Studio Code IDEs. If you address the issues and still see Maven errors, there might be an issue with your project. Use the information in the error logs to address any issues with your project, and then try transforming your project again. Transforming Java applications 199 Amazon Q Developer User Guide Update Maven conﬁguration in JetBrains If a transformation fails in JetBrains due to Maven command issues, the error logs appear on the Run tab. Use the information in the logs to address the issue. Following are some issues that you might need to address: • Make sure that your Maven home path is set to Bundled. Go to Settings, and then expand the Build, Execution, Deployment section. Expand the Build Tools section and then expand Maven. In the Maven home path dropdown list, choose Bundled. • Make sure that the Java runtime environment (JRE) is using your project JDK. Go to Settings, and then expand the Build, Execution, Deployment section. Expand Maven and choose Runner. In the JRE dropdown list, choose Use Project JDK. • Make sure that Maven is enabled. Go to Settings and choose Plugins. Search for Maven and choose the Maven plugin. If you see an Enable button, choose it to enable Maven. Update Maven conﬁguration in Visual Studio Code If a transformation fails in VS Code because of Maven command issues, a text ﬁle that contains the error logs opens in a new tab. Use the information in the logs to address the issue. Make sure that you have conﬁgured either one of the following options: • Your project contains a Maven wrapper in the project root folder • A version of Maven supported by Amazon Q is available on your PATH For more information, see How do I add Maven to my PATH? How do I add Maven to my PATH? To transform your code in VS Code without using a Maven wrapper, you must install Maven and add it to your PATH variable. To check if you have Maven installed correctly already, run mvn -v in a new OS terminal outside of Visual Studio Code. You should see an output with your Maven version. If you get an output in your Visual Studio Code terminal but not in your OS terminal, or if the command isn't found, you need to add Maven to your PATH. To add Maven to your PATH, follow the instructions for your machine. Transforming Java applications 200 Amazon Q Developer macOS User Guide To add Maven to your macOS PATH, complete the following steps. 1. Locate your Maven installation directory, or the folder where you installed Maven, and save the path to that folder. 2. Open the conﬁguration ﬁle for your shell in an editor of your choice. For recent macOS versions, the default shell is zsh and the default
amazonq-developer-ug-067	amazonq-developer-ug.pdf	67	terminal but not in your OS terminal, or if the command isn't found, you need to add Maven to your PATH. To add Maven to your PATH, follow the instructions for your machine. Transforming Java applications 200 Amazon Q Developer macOS User Guide To add Maven to your macOS PATH, complete the following steps. 1. Locate your Maven installation directory, or the folder where you installed Maven, and save the path to that folder. 2. Open the conﬁguration ﬁle for your shell in an editor of your choice. For recent macOS versions, the default shell is zsh and the default conﬁguration ﬁle is located at ~/.zshrc. Add the following lines to the bottom of the conﬁguration ﬁle. Set the value of M2_HOME to the path you saved in step 1: export M2_HOME="your Maven installation directory" export PATH="${M2_HOME}/bin:${PATH}" These commands make the mvn command available in all terminals. 3. Close all OS terminal windows and quit all Visual Studio Code instances. 4. To verify that Maven was added to your PATH, open a new OS terminal and run the following command: mvn -v You should see an output with your Maven version. 5. After seeing your Maven output, restart Visual Studio Code. You might also need to restart your machine. Open a new Visual Studio Code terminal and run the following command: mvn -v The output should be identical to the output in step 4. If the Visual Studio Code output is diﬀerent, try the following to make sure your setup is correct: • Check your PATH variable in Visual Studio Code. An IDE extension might be altering the PATH such that it diﬀers from your local PATH variable. Uninstall the extension to remove it from your PATH. • Check your default shell in Visual Studio Code. If it's set to something other than zsh, repeat these steps for your shell. Transforming Java applications 201 Amazon Q Developer Windows User Guide To add Maven to your Windows PATH, complete the following steps: 1. Locate your Maven installation directory, or the folder where you installed Maven, and save the path to that folder. 2. Open the Environment Variables window: a. b. Choose the Windows button to open the search bar. Enter Edit environment variables for your account and choose it. 3. 4. In the Environment Variables window, look for the Path variable. If you have a Path variable already, choose Edit... to update it. If you don't see a Path variable, choose New... to add one. In the Edit environment variable window that appears, double click the existing path to edit it, or choose New to add a new path entry. Replace the existing Maven path entry with the path you saved in step 1, or add the path as a new entry. At the end of the path, add \bin as a suﬃx, as in the following example: C:\Users\yourusername\Downloads\apache-maven-3.9.6-bin\apache-maven-3.9.6\bin 5. Choose OK to save the path entry, and then choose OK again in the Environment Variables window. 6. Open a new Command Prompt and run the following command: mvn -v You should see an output with your Maven version. Why can't Amazon Q build my code? If the transformation fails when Amazon Q is building your code, your project may not be conﬁgured properly for the environment where Amazon Q builds your code. You might need to update your build conﬁguration or code implementation. Review the build log output Amazon Q provides to determine if there are changes you can make to your project. Following are some common issues that might prevent Amazon Q from building your code. Transforming Java applications 202 Amazon Q Developer User Guide Remove absolute paths in pom.xml If you have an absolute path in your pom.xml ﬁle, Amazon Q won’t be able to ﬁnd the relevant ﬁles, and as a result might not be able to build your code. Following is an example of an absolute path that you could have in your pom.xml ﬁle: <toolspath> <path>/Library/Java/JavaVirtualMachines/jdk-11.0.11.jdk/Contents/Home/lib/ tools.jar</path> </toolspath> Instead of using an absolute path, you can create a relative path using a pointer. Following is an example of how you can replace the previous absolute path with a relative path: <toolspath> <path>${java.home}/../lib/tools.jar</path> </toolspath> Remove local or external databases in unit tests Amazon Q runs any unit tests in your project when it builds your code. If a unit test calls a local or external database, Amazon Q won’t have access to the database, causing the build to fail. To prevent the build from failing, you must either remove the database call from the unit test or remove the unit test before submitting the transformation. Why did my transformation fail after 55 minutes? If your code transformation job fails after 55 minutes, your code build time likely exceeds the build time limit. There is currently a
amazonq-developer-ug-068	amazonq-developer-ug.pdf	68	or external databases in unit tests Amazon Q runs any unit tests in your project when it builds your code. If a unit test calls a local or external database, Amazon Q won’t have access to the database, causing the build to fail. To prevent the build from failing, you must either remove the database call from the unit test or remove the unit test before submitting the transformation. Why did my transformation fail after 55 minutes? If your code transformation job fails after 55 minutes, your code build time likely exceeds the build time limit. There is currently a time limit of 55 minutes for building your code. If your local build time takes 55 minutes or longer, reduce your project’s build time to transform your code. If your local build is faster than the build with Code Transformation, check your project for tasks that might be failing or take a longer time in a diﬀerent environment. Consider disabling long-running test cases. Also consider using timeouts for attempts to access resources that might not be available from the secure IDE environment or the internet. Why can’t I download my transformed code? If you aren’t able to download your code after your transformation is complete, it’s likely due to one of the following issues. See the topic that corresponds to the error you see from Amazon Q. Transforming Java applications 203 Amazon Q Developer Topics • Reduce project size • Download code diﬀ within 30 days • Conﬁgure proxy settings in your IDE • Remove wildcard characters in JetBrains proxy settings Reduce project size User Guide After the transformation is complete, Amazon Q generates an output artifact that contains a diﬀ with your upgraded code and a transformation summary with information about the changes it made. The output artifact must be 1 GB or less in order for the IDE to download it. If the output artifact exceeds the limit, you will not be able to download your upgraded code or transformation summary. Try transforming a smaller project to prevent a large output artifact. If the issue persists, contact Support. For information about contacting Support with Amazon Q, see Using Amazon Q Developer to chat with Support. Download code diﬀ within 30 days The code diﬀ ﬁle with your upgraded code is only available for 30 days after the transformation is complete. If it’s been over 30 days since the transformation completed, restart the transformation to download the diﬀ ﬁle. Conﬁgure proxy settings in your IDE Amazon Q downloads your upgraded code from a service-owned Amazon S3 bucket. Part of the download process involves using SSL or TLS certiﬁcates to establish communication between Amazon S3 and your IDE. If you are using a proxy server, the SSL or TLS certiﬁcates used by your proxy server must be trusted, otherwise Amazon Q is not able to upload your project. To download your code, you might need to conﬁgure your IDE to trust certiﬁcates or update other proxy settings. For more information on updating your proxy settings, see Conﬁgure proxy settings in your IDE. Remove wildcard characters in JetBrains proxy settings If you have conﬁgured proxy settings in your JetBrains IDE, you might see the following error when downloading your upgraded code: Transforming Java applications 204 Amazon Q Developer User Guide software.amazon.awssdk.core.exception.SdkClientException: Unable to execute HTTP request: Dangling meta character '' near index 0 This is likely caused by the presence of a wildcard character () in the No proxy for ﬁeld of your IDE's proxy settings. The Java SDK used by Amazon Q doesn't support wildcard entries in this ﬁeld. To download your code, remove any wildcards from the No proxy for ﬁeld, and then restart your IDE. If you need to specify hosts that should bypass the proxy, use a regular expression instead of a wildcard. To update proxy settings in your JetBrains IDE, see HTTP Proxy in the JetBrains documentation. How do I access code transformation logs? Access logs in JetBrains For information about how to access JetBrains log ﬁles, see Locating IDE log ﬁles in the JetBrains documentation. To ﬁnd logs emitted by Amazon Q in JetBrains, search the IDE logs for the following string: software.aws.toolkits.jetbrains.services.codemodernizer Code transformation logs start with the preceding string. Logs generated by Maven are displayed on the Run tab and have the preceding string before and after the log entry. Access logs in Visual Studio Code To ﬁnd logs emitted by Amazon Q in VS Code, complete the following steps: 1. Choose View in the top navigation bar, and then choose Command Palette. 2. Search Amazon Q: View Logs in the command palette that appears. 3. The logs open in the IDE. To search the log ﬁles for CodeTransformation, use CMD + F or Control + F. Code transformation logs in VS Code
amazonq-developer-ug-069	amazonq-developer-ug.pdf	69	logs start with the preceding string. Logs generated by Maven are displayed on the Run tab and have the preceding string before and after the log entry. Access logs in Visual Studio Code To ﬁnd logs emitted by Amazon Q in VS Code, complete the following steps: 1. Choose View in the top navigation bar, and then choose Command Palette. 2. Search Amazon Q: View Logs in the command palette that appears. 3. The logs open in the IDE. To search the log ﬁles for CodeTransformation, use CMD + F or Control + F. Code transformation logs in VS Code are preﬁxed with CodeTransformation:. Following is an example of a log generated in VS Code for a Maven copy dependencies error: 2024-02-12 11:29:16 [ERROR]: CodeTransformation: Error in running Maven copy- dependencies command mvn = /bin/sh: mvn: command not found Transforming Java applications 205 Amazon Q Developer User Guide How do I ﬁnd my transformation job ID? Find your job ID in JetBrains To ﬁnd a transformation job ID in JetBrains, go to the Transformation details tab in the Transformation Hub and choose the Show Job Status (clock) icon. Find your job ID in Visual Studio Code To ﬁnd a transformation job ID in VS Code, go to the Transformation Hub and choose the Show Job Status (clock) icon. Transforming .NET applications with Amazon Q Developer Note Transforming .NET applications with Amazon Q in the IDE is in preview, and is subject to change. Amazon Q Developer can port your Windows-based .NET applications to Linux-compatible cross- platform .NET applications through a generative AI-powered refactoring workﬂow. Amazon Q also helps you upgrade outdated versions of cross-platform .NET applications to newer versions. To transform a .NET solution or project, Amazon Q analyzes your codebase, determines the necessary updates to port your application, and generates a transformation plan before the transformation begins. During this analysis, Amazon Q divides your .NET solution or project into code groups that you can view in the transformation plan. A code group is a project and all its dependencies that together generate a buildable unit of code such as a dynamic link library (DLL) or an executable. During the transformation, Amazon Q provides step-by-step updates in a Transformation Hub where you can monitor progress. After transforming your application, Amazon Q generates a summary with the proposed changes in a diﬀ view for you to optionally verify the changes before you accept them. When you accept the changes, Amazon Q makes in-place updates to your .NET solution or project. Amazon Q performs four keys tasks to port .NET applications to Linux: • Upgrades language version – Replaces outdated C# versions of code with Linux-compatible C# versions. Transforming .NET applications 206 Amazon Q Developer User Guide • Migrates from .NET Framework to cross-platform .NET – Migrates projects and packages from Windows dependent .NET Framework to cross-platform .NET compatible with Linux. • Rewrites code for Linux compatibility – Refactors and rewrites deprecated and ineﬃcient code components. • Generates a Linux compatibility readiness report – For open-ended tasks where user intervention is needed to make the code build and run on Linux, Amazon Q provides a detailed report of actions needed to conﬁgure your application after transformation. For more information about how Amazon Q performs .NET transformations, see How it works. Topics • Quotas • Porting a .NET application with Amazon Q Developer in Visual Studio • How Amazon Q Developer transforms .NET applications • Troubleshooting issues with .NET transformations in the IDE Quotas .NET transformations with Amazon Q in the IDE maintain the following quotas: • Lines of code per job – The maximum number of code lines that Amazon Q can transform in a given transformation job. This is also the monthly total limit for .NET transformations. • Concurrent jobs – The maximum number of transformation jobs you can run at the same time. This quota applies to all transformations in the IDE, including Java transformations. Resource Quotas Lines of code per job 100,000 lines of code Concurrent jobs 1 job per user 2 jobs per AWS account Transforming .NET applications 207 Amazon Q Developer User Guide Porting a .NET application with Amazon Q Developer in Visual Studio Note Transforming .NET applications with Amazon Q in the IDE is in preview, and is subject to change. Complete these steps to port a Windows-based .NET application to a Linux-compatible cross- platform .NET application with Amazon Q Developer in Visual Studio. Step 1: Prerequisites Before you continue, make sure you’ve completed the steps in Set up Amazon Q in your IDE. Make sure that the following prerequisites for your application are met before you begin a .NET transformation job: • Your application contains only .NET projects written in C#. • Your application only has Microsoft-authored NuGet package dependencies • Your application only uses
amazonq-developer-ug-070	amazonq-developer-ug.pdf	70	applications with Amazon Q in the IDE is in preview, and is subject to change. Complete these steps to port a Windows-based .NET application to a Linux-compatible cross- platform .NET application with Amazon Q Developer in Visual Studio. Step 1: Prerequisites Before you continue, make sure you’ve completed the steps in Set up Amazon Q in your IDE. Make sure that the following prerequisites for your application are met before you begin a .NET transformation job: • Your application contains only .NET projects written in C#. • Your application only has Microsoft-authored NuGet package dependencies • Your application only uses UTF-8 characters. If your application uses non-UTF-8 characters, Amazon Q will still attempt to transform your code. • If your application is dependent on Internet Information Services (IIS), only default IIS conﬁgurations are used • Amazon Q will evaluate the type of the project you selected and its dependencies to create a code group. Your code group can only have the following project types: • Console application • Class library • Web API • WCF Service • Business logic layers of Model View Controller (MVC) and Single Page Application (SPA) • Test projects Transforming .NET applications 208 Amazon Q Developer Note User Guide Amazon Q doesn’t support transforming UI layer components such as Razor views or WebForms ASPX ﬁles. If Amazon Q detects UI layer components in your solution or project, it will perform a partial transformation by excluding UI layer components, and you might need to refactor further to make your code buildable on the target .NET version. Step 2: Transform your application To transform your .NET solution or project, complete the following procedure: 1. Open any C# based solution or project in Visual Studio that you want to transform. 2. Open any C# code ﬁle in the editor. 3. Choose Solution Explorer. 4. From the Solution Explorer, right click a solution or project you want to transform, and then choose Port with Amazon Q Developer. 5. The Port with Amazon Q Developer window appears. The solution or project you selected will be chosen in the Choose a solution or project to transform dropdown menu. You can expand the menu to choose a diﬀerent solution or project to transform. In the Choose a .NET target dropdown menu, choose the .NET version you want to upgrade to. 6. Choose Conﬁrm to begin the transformation. 7. Amazon Q begins transforming your code. You can view the transformation plan it generates for details about how it will transform your application. A Transformation Hub opens where you can monitor progress for the duration of the transformation. After Amazon Q has completed the Awaiting job transformation startup step, you can navigate away from the project or solution for the duration of the transformation. 8. After the transformation is complete, navigate to the Transformation Hub and choose View diﬀs to review the proposed changes from Amazon Q in a diﬀ view. 9. Choose View code transformation summary for details about the changes Amazon Q made. You can also download the transformation summary by choosing Download summary as .md. Transforming .NET applications 209 Amazon Q Developer User Guide If any of the items in the Code groups table require input under the Linux porting status, you must manually update some ﬁles to run your application on Linux. a. From the Actions dropdown menu, choose Download Linux readiness report. b. A .csv ﬁle opens with any changes to your project or solution that you must complete before your application is Linux compatible. It includes the project and ﬁle that need to be updated, a description of the item to be updated, and an explanation of the issue. Use the Recommendation column for ideas on how to address a Linux readiness issue. 10. To update your ﬁles in place, choose Accept changes from the Actions dropdown menu. How Amazon Q Developer transforms .NET applications Note Transforming .NET applications with Amazon Q in the IDE is in preview, and is subject to change. Review the following sections for details about how .NET transformation with Amazon Q Developer works. Analyzing your application and generating a transformation plan Before a transformation begins, Amazon Q builds your code locally to ensure it’s buildable and conﬁgured correctly for transformation. Amazon Q then uploads your code to a secure and encrypted build environment on AWS, analyzes your codebase, and determines the necessary updates to port your application. During this analysis, Amazon Q divides your .NET solution or project into code groups. A code group is a project and all its dependencies that together generate a buildable unit of code such as a dynamic link library (DLL) or an executable. Even if you didn’t select all project dependencies to be transformed, Amazon Q determines the dependencies needed to build your selected projects and transforms them
amazonq-developer-ug-071	amazonq-developer-ug.pdf	71	buildable and conﬁgured correctly for transformation. Amazon Q then uploads your code to a secure and encrypted build environment on AWS, analyzes your codebase, and determines the necessary updates to port your application. During this analysis, Amazon Q divides your .NET solution or project into code groups. A code group is a project and all its dependencies that together generate a buildable unit of code such as a dynamic link library (DLL) or an executable. Even if you didn’t select all project dependencies to be transformed, Amazon Q determines the dependencies needed to build your selected projects and transforms them too, so that your transformed application will be buildable and ready for use. After analyzing your code, Amazon Q generates a transformation plan that outlines the proposed changes that it will make, including a list of code groups and their dependencies that will be transformed. Transforming .NET applications 210 Amazon Q Developer Transforming your application User Guide To start the transformation, Amazon Q builds your code again in the secure build environment to ensure it’s buildable remotely. Amazon Q then begins porting your application. It works from the bottom up, starting with the lowest level dependency. If Amazon Q runs into an issue with porting a dependency, it stops the transformation and provides information about what caused the error. The transformation includes the following updates to your application: • Replacing outdated C# versions of code with Linux-compatible C# versions • Upgrading .NET Framework to cross-platform .NET, including: • Identifying and iteratively replacing packages, libraries, and APIs • Upgrading and replacing NuGet packages and APIs • Transitioning to cross-platform runtime • Setting up middleware and updating runtime conﬁgurations • Replacing private or third-party packages • Handling IIS and WCF components • Debugging build errors • Rewriting code for Linux compatibility, including refactoring and rewriting deprecated and ineﬃcient code to port existing code Reviewing transformation summary and accepting changes After the transformation is complete, Amazon Q provides a transformation summary with information about the proposed updates it made to your application, including the number of ﬁles changed, packages updated, and APIs changed. It ﬂags any unsuccessful transformations, including aﬀected ﬁles or portions of ﬁles and the errors encountered during an attempted build. You can also view a build summary with build logs to learn more about what changes were made. The transformation summary also provides a Linux porting status, which indicates whether or not additional user input is needed to make the application Linux compatible. If any of the items in a code group require input from you, you download a Linux readiness report that contains Windows- speciﬁc considerations that Amazon Q could not address at build time. If input is needed for any code groups or ﬁles, review the report for details about what type of change still needs to be made and, if applicable, for recommendations for how to update your code. These changes must be made manually before your application can be run on Linux. Transforming .NET applications 211 Amazon Q Developer User Guide You can review the proposed changes Amazon Q made in a diﬀ view before accepting them as in-place updates to your ﬁles. After updating your ﬁles and addressing any items in the Linux readiness report, your application is ready to run on cross-platform .NET. Troubleshooting issues with .NET transformations in the IDE Note Transforming .NET applications with Amazon Q in the IDE is in preview, and is subject to change. Use the following sections to troubleshoot common issues with .NET transformations in the IDE with Amazon Q Developer. How do I know if a job is progressing? If Amazon Q appears to be spending a long time on a step in the Transformation Hub, you can check whether the job is still active in the output logs. If diagnostic messages are being generated, the job is still active. To check the outputs, choose the Output tab in Visual Studio. In the Show output from: menu, choose Amazon Q Language Client. The following screenshot shows an example of the outputs Amazon Q generates during a transformation. Why are some projects not selected for transformation? Amazon Q can only transform supported project types in the C# language. Currently, Amazon Q does not support porting UI layer components or projects written in the VB.NET or F# languages. For a list of supported project types and other prerequisites for transforming your .NET projects, see Step 1: Prerequisites. Transforming .NET applications 212 Amazon Q Developer User Guide How can I get support if my project or solution isn’t transforming? If you aren’t able to troubleshoot issues on your own, you can reach out to Support or your AWS account team to submit a support case. To get support, provide the transformation job ID so AWS can investigate a failed job.
amazonq-developer-ug-072	amazonq-developer-ug.pdf	72	Currently, Amazon Q does not support porting UI layer components or projects written in the VB.NET or F# languages. For a list of supported project types and other prerequisites for transforming your .NET projects, see Step 1: Prerequisites. Transforming .NET applications 212 Amazon Q Developer User Guide How can I get support if my project or solution isn’t transforming? If you aren’t able to troubleshoot issues on your own, you can reach out to Support or your AWS account team to submit a support case. To get support, provide the transformation job ID so AWS can investigate a failed job. To ﬁnd a transformation job ID, choose the Output tab in Visual Studio. In the Show output from: menu, choose Amazon Q Language Client. How can I prevent my ﬁrewall from interfering with transformation jobs? If your organization uses a ﬁrewall, it might interfere with transformations in Visual Studio. You can temporarily disable security checks in Node.js to troubleshoot or test what is preventing the transformation from running. The environment variable NODE_TLS_REJECT_UNAUTHORIZED controls important security checks. Setting NODE_TLS_REJECT_UNAUTHORIZED to "0" disables Node.js's rejection of unauthorized TLS/SSL certiﬁcates. This means: • Self-signed certiﬁcates will be accepted • Expired certiﬁcates will be allowed • Certiﬁcates with mismatched hostnames will be permitted • Any other certiﬁcate validation errors will be ignored If your proxy uses a self-certiﬁcate, you can set the following environment variables instead of disabling NODE_TLS_REJECT_UNAUTHORIZED: NODE_OPTIONS = —use-openssl-ca NODE_EXTRA_CA_CERTS = Path/To/Corporate/Certs Otherwise, you must specify the CA certs used by the proxy to disable NODE_TLS_REJECT_UNAUTHORIZED. To disbale NODE_TLS_REJECT_UNAUTHORIZED on Windows: 1. Open the Start menu and search for Environment Variables. 2. Choose Edit the system environment variables. 3. In the System Properties window, choose Environment Variables. Transforming .NET applications 213 Amazon Q Developer User Guide 4. Under System variables, choose New. 5. Set Variable name to NODE_TLS_REJECT_UNAUTHORIZED and Variable value to 0. 6. Choose OK to save the changes. 7. Restart Visual Studio. Developing features with Amazon Q Developer Amazon Q Developer can help you develop code features or make code changes to projects in your integrated development environment (IDE). You explain the task you want to accomplish, and Amazon Q uses the context of your current project or workspace to generate code to implement the changes. Amazon Q can help you build AWS projects or your own applications. You can start an entirely new project, or work on an open project in your IDE. When you develop in an existing project, Amazon Q uses all relevant ﬁles in your workspace root as context to generate code. Amazon Q ﬁlters out ﬁles or folders deﬁned in a .gitignore ﬁle, and only uses supported ﬁle types to generate code. For a list of supported ﬁle types, see the following GitHub links for your IDE: • Supported ﬁle types for JetBrains IDEs – https://github.com/aws/aws-toolkit-jetbrains/ blob/main/plugins/core/jetbrains-community/src/software/aws/toolkits/jetbrains/services/ telemetry/TelemetryUtils.kt • Supported ﬁle types for Visual Studio Code – https://github.com/aws/aws-toolkit-vscode/blob/ master/packages/core/src/shared/ﬁletypes.ts To get started, open up a new or existing project and enter /dev in the Amazon Q chat panel. A new chat tab opens where you interact with Amazon Q to generate new code for your feature. Topics • Develop features with /dev • Best practices • Example tasks • Quotas • Testing code suggestions generated by the Amazon Q '/dev' command • Troubleshooting issues with feature development with Amazon Q Developer Developing features (/dev) 214 Amazon Q Developer User Guide Develop features with /dev To work on a code task with Amazon Q in your IDE, complete the following steps. 1. In your IDE, open a new or existing project or workspace where you want to develop features. 2. Choose the Amazon Q icon to open the Amazon Q chat panel. 3. Enter /dev in the Amazon Q chat panel followed by a description of the task you want to accomplish or the issue you want to resolve. You can provide a brief overview of a task, or add more details. Amazon Q uses your description and the code in your project to generate code. Following is an example of a code change you can ask Amazon Q to implement: /dev Create a new REST API endpoint /api/authenticate to handle user authentication. This endpoint should accept POST requests with user credentials and return a JWT token upon successful authentication. Additionally, update the user management system to integrate with the new authentication endpoint and enforce authentication for relevant API endpoints. You can also enter /dev only to see example tasks. 4. A new tab opens. If you haven't already, enter a description of your task or issue. 5. Amazon Q begins to generate code for the task you've described. During the code generation, Amazon Q provides a summary of the steps it's taking and the ﬁles it's using or updating to suggest new code. This
amazonq-developer-ug-073	amazonq-developer-ug.pdf	73	should accept POST requests with user credentials and return a JWT token upon successful authentication. Additionally, update the user management system to integrate with the new authentication endpoint and enforce authentication for relevant API endpoints. You can also enter /dev only to see example tasks. 4. A new tab opens. If you haven't already, enter a description of your task or issue. 5. Amazon Q begins to generate code for the task you've described. During the code generation, Amazon Q provides a summary of the steps it's taking and the ﬁles it's using or updating to suggest new code. This step can take a few minutes. If you want Amazon Q to stop generating code, choose Stop. The incomplete code generation will count towards the code generation quota for this task. After you stop a generation, you have the option to enter another task description to keep working on your task. Optionally, Amazon Q can test its code suggestions in a separate dev environment before presenting them to you in the chat window. For more information, see Testing '/dev' suggestions. 6. After Amazon Q has generated code for your task, it provides a list of ﬁles with suggested changes. Choose a ﬁle to view a ﬁle diﬀ with the changes. 7. To update your ﬁles with all of the suggested code changes, choose Accept all changes. You can also accept and reject changes to individual ﬁles. To accept an individual ﬁle change, hover your cursor over a ﬁle name and choose the green check mark. To reject a change, choose Develop features with /dev 215 Amazon Q Developer User Guide the red X. You can also choose Accept remaining changes to apply any changes you haven't accepted yet. Once you accept a code change, you can't undo it. If you reject a code change, you can revert it by hovering over the ﬁle name and choosing the arrow. You then have the option to accept or reject the code change again. 8. If you aren’t satisﬁed with the proposed changes, you can provide feedback on what can be improved. Choose Provide feedback & regenerate, and then describe the changes that you'd like Amazon Q to make. Amazon Q generates new code based on your feedback. When the generated code meets your requirements, choose Accept all changes or accept individual ﬁles to update the code in your project or workspace. 9. After you've updated your code, Amazon Q prompts you to start working on a new task. To start working on another task in your project or workspace, choose Yes, I have another task. Your previous conversation and generated code aren't used as context for the new task. To end the feature development session, choose No, thanks. To keep chatting or initiate another workﬂow with Amazon Q, open a new chat tab. Best practices To make the most out of feature development with Amazon Q, follow these best practices: • Provide a detailed description of the new feature or code changes you want to make, including the speciﬁcs of what the code should achieve. This allows Amazon Q to propose comprehensive and implementable code changes. For examples, see Example tasks. • Your feature shouldn’t require updates to more than 5 ﬁles at a time. Asking Amazon Q to make larger changes might impact the quality and manageability of the implementation of your feature. If your ﬁle diﬀ includes changes to many ﬁles, try reducing the scope of your feature description. Example tasks Following are example feature development tasks you can ask Amazon Q to perform, with the corresponding description you might provide. Best practices 216 Amazon Q Developer User Guide • Update CSS Styles for Responsive Layout: Enhance the responsiveness of the application's layout by updating CSS styles. Focus on adjusting the layout for diﬀerent screen sizes, ensuring optimal display across various devices. • Fix User Proﬁle Image Upload: Resolve the issue preventing users from uploading proﬁle images. Investigate the ﬁle upload process, ensure proper ﬁle type validation, and address any server-side errors preventing successful uploads. • Refactor Code for Code Readability: Improve the readability of a speciﬁc code module by refactoring it. Break down complex functions into smaller, more manageable units, and apply meaningful variable and function names for better clarity. • Implement Input Validation for Contact Form: Add client-side and server-side input validation to the contact form to prevent submission of empty or invalid data. Display appropriate error messages to users for any validation failures. • Resolve Broken Links in Navigation Menu: Investigate and ﬁx broken links in the navigation menu of the application. Update the URLs or routes to ensure all navigation links lead to the correct pages. • Optimize Image Loading for Faster Page Loads: Optimize image loading on key pages of the application to reduce page
amazonq-developer-ug-074	amazonq-developer-ug.pdf	74	units, and apply meaningful variable and function names for better clarity. • Implement Input Validation for Contact Form: Add client-side and server-side input validation to the contact form to prevent submission of empty or invalid data. Display appropriate error messages to users for any validation failures. • Resolve Broken Links in Navigation Menu: Investigate and ﬁx broken links in the navigation menu of the application. Update the URLs or routes to ensure all navigation links lead to the correct pages. • Optimize Image Loading for Faster Page Loads: Optimize image loading on key pages of the application to reduce page load times. Implement lazy loading or asynchronous loading techniques to prioritize the display of visible content. • Add Error Logging for Critical API Endpoints: Enhance error handling by implementing logging for critical API endpoints. Log relevant error details such as request parameters and stack traces to facilitate debugging and troubleshooting. • Update Documentation for API Endpoints: Review and update the documentation for existing API endpoints to reﬂect recent changes or additions. Ensure accuracy and completeness of information for developers consuming the API. • Refactor Database Queries for Eﬃciency: Analyze and optimize database queries to improve eﬃciency and reduce resource consumption. Identify and eliminate redundant queries, optimize indexing, and consider caching strategies where applicable. Quotas Feature development with Amazon Q maintains the following quotas: • Code generations per task – The number of times you can provide feedback to regenerate code for a given development task, including the initial code generation. This quota is reset every time you start a new task. Quotas 217 Amazon Q Developer User Guide • Code project size – The maximum size of the code ﬁle or folder that Amazon Q can use as context to generate new code. Quotas Resource Code generations per task Quota 10 Code project size 200 MB uncompressed 50 MB compressed Testing code suggestions generated by the Amazon Q '/dev' command By default, when you use the /dev command, Amazon Q does not automatically test the code that it presents to you in the chat. You need to save the code and then test it separately. Amazon Q can’t test its code because it lacks an environment with the tools necessary to complete the work. To enable Amazon Q to test its code, you must allow it to launch a dev environment by providing it with a devﬁle. Note For more information about the /dev command and the Amazon Q Developer Agent for software development, see Developing features with Amazon Q Developer. What is a dev environment? A dev environment is a Docker container in which Amazon Q can test its code before presenting it to you in the chat. The container includes the preinstalled tools, languages, and frameworks necessary to test the code. Amazon Q launches the Docker container in a sandbox, meaning the container is isolated from AWS services to protect them from problematic code that Amazon Q might generate. Testing '/dev' suggestions 218 Amazon Q Developer What is a devﬁle? User Guide A devﬁle is a YAML ﬁle that complies with the devﬁle speciﬁcation, which is an open standard deﬁning containerized development environments, or dev environments for short. A devﬁle describes: • The name and location of Docker container image to be used as the dev environment. • The commands to run automatically when the dev environment is launched. A devﬁle can contain other types of information, but the two mentioned previously are the ones relevant to Amazon Q. You can provide your own devﬁle, or you can let Amazon Q generate one for you. How it works Whenever you enter the /dev command into the Amazon Q chat panel, Amazon Q looks for a devﬁle in the root of your project. If a devﬁle exists, Amazon Q: 1. Launches a dev environment in a sandbox, in AWS. 2. Generates a code suggestion (but doesn't present it to you yet). 3. Builds and tests the suggestion in the dev environment using the instructions in the devﬁle. 4. Iterates on the suggestion if the tests aren’t passing. Amazon Q conducts three iterations, and this is not conﬁgurable. 5. Presents the tested code in the chat window. 6. Terminates the dev environment. If a devﬁle doesn’t exist, Amazon Q asks you whether you want to generate one. If you say yes, Amazon Q generates a devﬁle based on the context of your project. For more information about what this devﬁle might look like, see Example devﬁles in Amazon Q Developer. After generating the devﬁle, Amazon Q does not start using it. You’ll need to enter another /dev command to invoke the devﬁle. Testing '/dev' suggestions 219 Amazon Q Developer Sandbox speciﬁcations User Guide The sandbox in which a dev environment is launched has 2 vCPUs and 4 GB of memory.
amazonq-developer-ug-075	amazonq-developer-ug.pdf	75	dev environment. If a devﬁle doesn’t exist, Amazon Q asks you whether you want to generate one. If you say yes, Amazon Q generates a devﬁle based on the context of your project. For more information about what this devﬁle might look like, see Example devﬁles in Amazon Q Developer. After generating the devﬁle, Amazon Q does not start using it. You’ll need to enter another /dev command to invoke the devﬁle. Testing '/dev' suggestions 219 Amazon Q Developer Sandbox speciﬁcations User Guide The sandbox in which a dev environment is launched has 2 vCPUs and 4 GB of memory. The CPU and memory are not conﬁgurable. Amazon VPC support Amazon Q doesn't support running dev environments within your Amazon Virtual Private Cloud (Amazon VPC). For more information about Amazon VPC, see What is Amazon VPC? in the Amazon Virtual Private Cloud User Guide. Topics • Conﬁguring a devﬁle in Amazon Q • Disabling Amazon Q from testing its code suggestions • Example devﬁles in Amazon Q Developer • Universal image contents Conﬁguring a devﬁle in Amazon Q To enable Amazon Q to test the code suggestions it generates in response to a /dev command, you must conﬁgure a devﬁle. You can either: • Have Amazon Q generate a devﬁle for you based on the context of your project. • Create a devﬁle yourself. For more information about devﬁles and testing with Amazon Q, see Testing code suggestions generated by the Amazon Q '/dev' command. To have Amazon Q generate a devﬁle for you 1. In your IDE, run a /dev command. Amazon Q generates an untested suggestion, which it presents to you in the chat window. 2. At the end of the suggestion, choose the Generate devﬁle to build code button. Amazon Q generates a devﬁle. 3. Save the ﬁle as devfile.yaml in your project’s root folder. Testing '/dev' suggestions 220 Amazon Q Developer User Guide After saving the devﬁle, Amazon Q will begin to use it the next time the /dev command is used. 4. (Optional but recommended) Commit and push the devﬁle so that it’s available to other users. To conﬁgure your own devﬁle 1. Start with a basic devﬁle. You can have Amazon Q generate one for you (see the previous procedure), or you can use one of the examples in Example devﬁles in Amazon Q Developer. 2. Modify the devﬁle to suit your needs, following the guidelines in the next section, Guidelines for conﬁguring your own devﬁle . 3. Save the ﬁle as devfile.yaml in your project’s root folder. After saving the devﬁle, Amazon Q will begin to use it the next time the /dev command is used. 4. (Optional but recommended) Commit and push the devﬁle so that it’s available to other users. Guidelines for conﬁguring your own dev ﬁle • The Docker image speciﬁed in image: must reside in a public image registry like DockerHub or a public Amazon ECR registry. Private registries are not supported. • The devﬁle must conform to the devﬁle 2.2.0 schema. • Not all objects in the devﬁle 2.2.0 schema are supported. Amazon Q only supports the install, build, and test commands. You can include other commands, but they won't be run. • The commands in commands: must take less than ﬁve minutes to run in total. They’ll time out after ﬁve minutes. • If you need to reference artifacts, they must reside in a public artifact repository like PyPI or npmjs.com. Private artifact repositories are not supported. • Do not reference AWS resources (or any resources) that require authenticated access, such as Amazon S3 buckets. This is because the dev environment's Docker container is sandboxed and only has access to public resources on the Internet. Testing '/dev' suggestions 221 Amazon Q Developer User Guide Disabling Amazon Q from testing its code suggestions To turn oﬀ the feature that allows Amazon Q to test its code suggestions in a dev environment, go to your IDE’s settings and turn oﬀ the Amazon Q: Allow Q /dev to run code and test commands setting. (You might need to choose the Edit in settings.json link under the setting name, and then set the corresponding JSON setting to false to turn oﬀ the setting.) When you turn oﬀ this setting: • Amazon Q will no longer display the Generate devﬁle to build code button to you when you run the /dev command in your IDE. • Amazon Q will no longer look for a devﬁle, launch a dev environment, or test the code suggestions it generates for you. Note The ability to enable or disable the use of dev environments is not possible through the Amazon Q Developer console. For more information about devﬁles and testing with Amazon Q, see Testing code suggestions generated by the Amazon Q '/dev' command. Example devﬁles
amazonq-developer-ug-076	amazonq-developer-ug.pdf	76	the setting.) When you turn oﬀ this setting: • Amazon Q will no longer display the Generate devﬁle to build code button to you when you run the /dev command in your IDE. • Amazon Q will no longer look for a devﬁle, launch a dev environment, or test the code suggestions it generates for you. Note The ability to enable or disable the use of dev environments is not possible through the Amazon Q Developer console. For more information about devﬁles and testing with Amazon Q, see Testing code suggestions generated by the Amazon Q '/dev' command. Example devﬁles in Amazon Q Developer The following examples show devﬁles that comply with the devﬁle speciﬁcation and are suitable for use with Amazon Q. The examples are explained at the end of this page. For more information about devﬁles and how they're used in Amazon Q, see Testing code suggestions generated by the Amazon Q '/dev' command. Python example The following example shows a devﬁle that you could use with a Python project. schemaVersion: 2.0.0 components: - name: dev container: Testing '/dev' suggestions 222 Amazon Q Developer User Guide image: public.ecr.aws/aws-mde/universal-image:latest commands: - id: install exec: component: dev commandLine: "pip3.11 install -r requirements.txt" - id: test exec: component: dev commandLine: "python3.11 manage.py makemigrations && python3.11 manage.py test" Node example The following example shows a devﬁle that you could use with a Node.js project. schemaVersion: 2.0.0 components: - name: dev container: image: public.ecr.aws/aws-mde/universal-image:latest commands: - id: install exec: component: dev commandLine: "npm install" - id: build exec: component: dev commandLine: "npm run build" - id: test exec: component: dev commandLine: "npm run test" Explanation of examples The following table describes each line or code block in the preceding devﬁle examples. Line or code block Description schemaVersion: 2.0.0 Speciﬁes the devﬁle schema version. Amazon Q only supports schema version 2.0.0. Testing '/dev' suggestions 223 Amazon Q Developer User Guide Line or code block Description components: - name: dev container: A list of components to deploy onto the dev environment. Indicates to use the latest universal image Docker image available in the public Amazon image: public.ecr.aws/aws-mde/ Elastic Container Registry (Amazon ECR) as the universal-image:latest dev environment. You can change the version of this image, or you can replace the image with one of your own. For more information, see Universal image contents. commands: A list of commands to perform. - id: install\|build\|test exec: component: dev commandLine: " cli-instructions " An install, build, or test command. Amazon Q runs the cli-instructions instructions in the dev environment, on the universal image (or whatever image is speciﬁed in image:). The cli-instr uctions will be diﬀerent depending on the context of your project. You can change these commands to suit your needs. Universal image contents When Amazon Q generates a devﬁle, it will set the devﬁle's image: setting to point to the universal image. The universal image is a public Docker image that includes preinstalled frameworks, languages, and tools that Amazon Q can use to test its code suggestions. There are two supported versions of the universal image: • 3.0 • 4.0 Testing '/dev' suggestions 224 Amazon Q Developer Note The latest universal image maps to 3.0 (not 4.0). User Guide For the list of packages installed on versions 3.0 and 4.0 of the universal image, see the following tables. Amazon regularly patches the universal image packages following the version schema in the Versioning schema column. If you're using later versions of the packages listed in the tables, or you need a diﬀerent set of packages to be present, you have two options: You can add commands that describe how to install the required packages to the commands: section of the devﬁle, or you can supply your own Docker image containing the correct packages in the image: ﬁeld. For more information about testing code suggestions, see Testing code suggestions generated by the Amazon Q '/dev' command. Universal image 3.0 (latest) Package aws-cli docker-compose dotnet golang java nodejs openssl php python Versioning schema 2.x 2.x 6.x, 7.x 1.21.x corretto11.x, corretto17.x 18.x, 20.x 3.x 8.2.x 3.x Testing '/dev' suggestions 225 Amazon Q Developer Package ruby terraform Universal image 4.0 Package aws-cli docker-compose dotnet golang java nodejs php python ruby terraform User Guide Versioning schema 3.x 1.x Versioning schema 2.x 2.x 8.x 1.22.x corretto21.x 20.x 8.2.x 3.x 3.x 1.x Troubleshooting issues with feature development with Amazon Q Developer The following information can help you troubleshoot common issues while developing features in the IDE with Amazon Q Developer. Troubleshooting 226 Amazon Q Developer User Guide How do I ﬁnd my conversation ID? You might need your conversation ID to get support for issues that arise during feature development with Amazon Q. For some error messages, the conversation ID appears in the message from Amazon Q. If you don't see it, use the
amazonq-developer-ug-077	amazonq-developer-ug.pdf	77	User Guide Versioning schema 3.x 1.x Versioning schema 2.x 2.x 8.x 1.22.x corretto21.x 20.x 8.2.x 3.x 3.x 1.x Troubleshooting issues with feature development with Amazon Q Developer The following information can help you troubleshoot common issues while developing features in the IDE with Amazon Q Developer. Troubleshooting 226 Amazon Q Developer User Guide How do I ﬁnd my conversation ID? You might need your conversation ID to get support for issues that arise during feature development with Amazon Q. For some error messages, the conversation ID appears in the message from Amazon Q. If you don't see it, use the following steps to ﬁnd the conversation ID in your IDE. Visual Studio Code 1. Open the Command Palette, and run the following command: Amazon Q: View Logs. 2. An output console opens in the VS Code terminal. Search for the following string: Amazon Q Developer Agent for software development Conversation ID: The conversation ID is listed after the colon. Conﬁrm that the timestamp corresponds to the conversation that you need the ID for. JetBrains 1. At the top of the IDE, choose Help, and then Show Log in Finder. Depending on your JetBrains IDE and operating system, the logs menu text might look diﬀerent. For more information, see Locating IDE log ﬁles in the IntelliJ IDEA documentation. 2. Your ﬁle ﬁnder opens. Choose idea.log to open the log ﬁle. 3. Search for the following string: Amazon Q Developer Agent for software development Conversation ID: The conversation ID is listed after the colon. Conﬁrm that the timestamp corresponds to the conversation that you need the ID for. Troubleshooting 227 Amazon Q Developer User Guide Generating unit tests with Amazon Q Amazon Q Developer agent provides an AI-powered unit test generation capability that automates the creation of unit tests throughout the software development lifecycle. This feature helps developers focus on accelerating feature development while ensuring code quality. The Amazon Q agent for unit tests automates the following steps: • Test case identiﬁcation: The agent uses your project structure, existing code, and targeted ﬁle in the workspace to identify appropriate test cases. • Mock and stub creation: Amazon Q generates necessary mocks and stubs for isolated testing. • Test code generation: The agent produces unit tests based on the identiﬁed test cases. The Amazon Q agent for unit tests supports Java and Python projects in VS Code and JetBrains IDEs. To learn about the supported test frameworks for each programming language, see the section called “Unit test generation (/test)”. Prerequisites To use the unit test generation feature, you must download and install the Amazon Q IDE extension for VS Code or JetBrains IDEs. Follow the instructions in the section called “Installing Amazon Q” to set up the extension. Note While recommended, a functional project with a test framework setup in your IDE is optional. Generate unit tests with /test After writing code, developers can initiate unit test generation in two primary ways: • Type /test in the Amazon Q chat, optionally specifying instructions for the class, function, or method to consider. • Highlight a section of code, open the right-click Amazon Q menu, and choose the Generate tests option. Generating unit tests (/test) 228 Amazon Q Developer User Guide When developers use the /test command without additional prompt, the agent: • Examines the currently active ﬁle in the IDE. • Checks for the existence of a corresponding unit test ﬁle for this active ﬁle in a test directory. • If no such test ﬁle is found, it automatically creates a new one. The new test ﬁle is named after the original ﬁle, with a test preﬁx or suﬃx appended based on the test framework in use, and is placed in the test directory. • If a test ﬁle already exists, it appends the new unit tests to the existing ﬁle. Unit test generation process The process involves the following steps: 1. Input inference: Amazon Q infers the target code, output ﬁle, and appropriate test and mock based on the workspace context and conﬁgured test framework. The agent identiﬁes where to place the generated tests, either in an existing or new test ﬁle, and determines the target code to test. Developers can provide optional instructions to specify their target code and target ﬁle name. 2. Context enrichment: Amazon Q unit tests agent uses the open project as context, allowing it to generate tests that align with the IDE project's code and dependencies. 3. Test generation: The Amazon Q agent infers the appropriate inputs for unit test generation or allows users to provide that information manually. It then generates the unit tests. Throughout this process, the agent provides progress updates in the chat. Note • When working with large projects, the initial project analysis may take some time. During this process, the progress indicator might

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.