Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Returns information about an extension's registration, including its current status and type and version identifiers.
When you initiate a registration request using
RegisterType
, you
can then use
DescribeTypeRegistration
to monitor the progress of
that registration request.
Once the registration request has completed, use
DescribeType
to
return detailed information about an extension.
Synopsis
- data DescribeTypeRegistration = DescribeTypeRegistration' {}
- newDescribeTypeRegistration :: Text -> DescribeTypeRegistration
- describeTypeRegistration_registrationToken :: Lens' DescribeTypeRegistration Text
- data DescribeTypeRegistrationResponse = DescribeTypeRegistrationResponse' {}
- newDescribeTypeRegistrationResponse :: Int -> DescribeTypeRegistrationResponse
- describeTypeRegistrationResponse_description :: Lens' DescribeTypeRegistrationResponse (Maybe Text)
- describeTypeRegistrationResponse_progressStatus :: Lens' DescribeTypeRegistrationResponse (Maybe RegistrationStatus)
- describeTypeRegistrationResponse_typeArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text)
- describeTypeRegistrationResponse_typeVersionArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text)
- describeTypeRegistrationResponse_httpStatus :: Lens' DescribeTypeRegistrationResponse Int
Creating a Request
data DescribeTypeRegistration Source #
See: newDescribeTypeRegistration
smart constructor.
DescribeTypeRegistration' | |
|
Instances
newDescribeTypeRegistration Source #
Create a value of DescribeTypeRegistration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:registrationToken:DescribeTypeRegistration'
, describeTypeRegistration_registrationToken
- The identifier for this registration request.
This registration token is generated by CloudFormation when you initiate
a registration request using
RegisterType
.
Request Lenses
describeTypeRegistration_registrationToken :: Lens' DescribeTypeRegistration Text Source #
The identifier for this registration request.
This registration token is generated by CloudFormation when you initiate
a registration request using
RegisterType
.
Destructuring the Response
data DescribeTypeRegistrationResponse Source #
See: newDescribeTypeRegistrationResponse
smart constructor.
DescribeTypeRegistrationResponse' | |
|
Instances
newDescribeTypeRegistrationResponse Source #
Create a value of DescribeTypeRegistrationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTypeRegistrationResponse
, describeTypeRegistrationResponse_description
- The description of the extension registration request.
$sel:progressStatus:DescribeTypeRegistrationResponse'
, describeTypeRegistrationResponse_progressStatus
- The current status of the extension registration request.
DescribeTypeRegistrationResponse
, describeTypeRegistrationResponse_typeArn
- The Amazon Resource Name (ARN) of the extension being registered.
For registration requests with a ProgressStatus
of other than
COMPLETE
, this will be null
.
$sel:typeVersionArn:DescribeTypeRegistrationResponse'
, describeTypeRegistrationResponse_typeVersionArn
- The Amazon Resource Name (ARN) of this specific version of the extension
being registered.
For registration requests with a ProgressStatus
of other than
COMPLETE
, this will be null
.
$sel:httpStatus:DescribeTypeRegistrationResponse'
, describeTypeRegistrationResponse_httpStatus
- The response's http status code.
Response Lenses
describeTypeRegistrationResponse_description :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #
The description of the extension registration request.
describeTypeRegistrationResponse_progressStatus :: Lens' DescribeTypeRegistrationResponse (Maybe RegistrationStatus) Source #
The current status of the extension registration request.
describeTypeRegistrationResponse_typeArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the extension being registered.
For registration requests with a ProgressStatus
of other than
COMPLETE
, this will be null
.
describeTypeRegistrationResponse_typeVersionArn :: Lens' DescribeTypeRegistrationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of this specific version of the extension being registered.
For registration requests with a ProgressStatus
of other than
COMPLETE
, this will be null
.
describeTypeRegistrationResponse_httpStatus :: Lens' DescribeTypeRegistrationResponse Int Source #
The response's http status code.